List departments

Lists the departments set up in Exsited, one page at a time.

GET /settings/departments

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/departments?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "code": "<string>",
      "created_by": null,
      "created_on": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "division": {
        "id": "<string>",
        "name": "<string>",
        "object": "<string>"
      },
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": null,
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Returns one page of departments under data, with pagination for the next page. Each department carries its code, name, display_name, description, status and the division it belongs to. Some departments in the list have a null id; those cannot be retrieved on their own. Any other field of the record filters the listing as filter_<field> or filter_<field>_<operator>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

How many records to return on one page.

Example:

20

cursor · string

The next_cursor of the previous page, to fetch the page after it.

sort · string

The field to sort by; prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

One page of departments.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string