Custom Fields

Retrieve one custom field

Retrieves one custom field

get/v1/custom-fields/{id}

Request

  • Base URL: https://api.atlas.so
  • URL: https://api.atlas.so/v1/custom-fields/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Successful Response

updatedAtstring date-time nullable
createdAtstring date-time nullable
keystring nullable
companyIdstring uuid nullable
displayNamestring nullable
descriptionstring nullable
category'account' | 'customer' | 'ticket'
fieldMetadatastring[] nullable
dynamicFieldMetadataobject nullable
type'Text' | 'Number' | 'Decimal' | 'Boolean' | 'Date' | 'List' | 'MultiSelect' | 'Agent' | 'Customer' | 'Ticket' | 'Account' | 'URL' | 'Address' | 'DynamicList' | 'DynamicMultiSelect'
requiredboolean nullable
editableByEditableBy[] nullable
activeboolean nullable
dependsOnstring[] nullable
idstring uuid nullable

Changes

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