COconnecteam
Users:v1:Custom Field Categories

Get custom field categories

Retrieves all custom fields categories associated with the account. Optionally, filter the results by category IDs and/or names.

get/users/v1/custom-field-categories

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/users/v1/custom-field-categories
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: users.read

Query parameters

limitinteger

The maximum number of results to display per page

offsetinteger

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

categoryIdsinteger[]

Custom field category ids to filter by

categoryNamesstring[]

Custom field category names to filter by

sort'id' | 'name'

An enumeration.

Sort key

order'asc' | 'desc'

Sort order, set only if sort key is set

Response

Successful Response

requestIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.