COconnecteam
Users:v1:Custom Fields:Custom Field options

Get custom field options

Retrieve a list of all dropdown value options under a specified custom field

get/users/v1/custom-fields/{customFieldId}/options

Request

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

Path parameters

customFieldIdinteger required

The unique identifier of the custom field

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

isDisabledboolean

Parameter specifying the if to filter only for disabled options.

isDeletedboolean

Parameter specifying the if to filter only for deleted options.

Response

Successful Response

requestIdstring

Changes

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