API Reference

Get custom fields

get
https://api.connecteam.com/users/v1/custom-fields

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
customFieldIds
array of integers

Custom field ids to filter by

Customfieldids
categoryIds
array of integers

Custom field category ids to filter by

Categoryids
customFieldTypes
array of objects

Custom field types to filter by

customFieldTypes
customFieldNames
array of strings

Custom field names to filter by

Customfieldnames
integer
1 to 500
Defaults to 10

The maximum number of results to display per page

integer
≥ 0
Defaults to 0

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

enum

Sort key

Allowed:
string
enum
Defaults to asc

Sort order, set only if sort key is set

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?