CAcarecycle
Custom Fields

List custom fields

List the custom fields you've set up to store extra details on customers and policies. Results come back one page at a time.

get/v2/custom-fields

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/custom-fields
  • Auth
    API key in header x-api-key

Query parameters

pagenumber

GET /v2/custom-fields Parameter

perPagenumber

GET /v2/custom-fields Parameter

recordType'customers' | 'policies'

Filter by record type

sortBy'createdAt' | 'fieldLabel' | 'fieldType'

Field to sort by

sortDirection'asc' | 'desc'

Sort direction

Response

GET /v2/custom-fields Positive response

itemsTotalnumber required
currentPagenumber required
nextPagenumber nullable required
prevPagenumber nullable required

Changes

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