Sign in

v1

latestOpenAPI 3.0.12026-07-2466310316.3 KB
Departments

List Departments

get/api/v1/departments

Query parameters

fields[departments]DepartmentsReadableAttribute[]

Department readable attributes list

Include only specified fields of Department in response

filter[created_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at greater than this value

filter[created_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at less than this value

filter[updated_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at greater than this value

filter[updated_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at less than this value

filter[external_system_reference]string[]

External system reference filter

Filter records by External system reference

sortstring[]

Department sortable attributes

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

page[number]integer
Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'
Example:count

Include the total number of matched records within the meta key of the response object.

Response

OK: Departments collection