COconnecteam
Users:v1:Custom Fields

Get custom fields

Retrieves all custom fields associated with the account. Optionally, filter the results by categories, names, types, or custom field IDs.

get/users/v1/custom-fields

Request

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

Query parameters

customFieldIdsinteger[]

Custom field ids to filter by

categoryIdsinteger[]

Custom field category ids to filter by

customFieldTypesUserCustomFields[]

Custom field types to filter by

customFieldNamesstring[]

Custom field names to filter by

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

sort'id' | 'name' | 'type'

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.