Client Divisions

Get a list of client divsions

This method requires the ClientDivisions:Get permission to be associated with your role.

GET

/fm/client-divisions

curl --request GET \
  --url 'https://api.catch-e.com/fm/client-divisions?client_id=%3Cstring%3E&description=%3Cstring%3E&fields=%3Cstring%3E&include_deleted_flag=no&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "fm_client_divisions": [
      {
        "client_division_id": "<string>",
        "client_id": "<string>",
        "description": "<string>",
        "status_flag": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/client-divisions"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

client_idstringqueryrequired

Mandatory

descriptionstringquery

This field supports the wildcard % operator.

fieldsstring[]query

Define fields required. If no fields are specified, then all fields are returned.

include_deleted_flagenum<string>querydefault:norequired

Set to yes if inactive Client Cost Centres required in the list. Note 'deleted' records cannot be returned. Default no.

Available options: yes, no

pageintegerquerydefault:1

Required range: -1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team