BIbigchange
Custom Fields

Get a custom field definition by its id

Changed on

Get a custom field definition by its id. Inactive (soft-deleted) definitions are returned with isActive: false rather than a 404. (required scope customfields:read)

get/v1/customFields/{customFieldId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/customFields/{customFieldId}
  • Auth
    HTTP bearer

Path parameters

customFieldIdinteger required

The unique identifier of the custom field definition

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the custom field definition

namestring

The name of the custom field

entityType'contact' | 'note' | 'job' | 'vehicle' | 'user' | 'resource' | 'financialDocument' | 'person' | 'stock' | 'Unknown'

The kind of entity a custom field definition is attached to.<p>Possible values:</p><ul><li><b>contact</b>: Contact entity</li><li><b>note</b>: Contact note entity</li><li><b>job</b>: Job entity</li><li><b>vehicle</b>: Vehicle entity</li><li><b>user</b>: User entity</li><li><b>resource</b>: Resource entity</li><li><b>financialDocument</b>: Financial document entity (invoice or invoice line item)</li><li><b>person</b>: Person entity</li><li><b>stock</b>: Stock entity</li><li><b>unknown</b>: Fallback used when the underlying entity type has no corresponding API vocabulary value</li></ul>

fieldType'text' | 'number' | 'date' | 'dateTime' | 'boolean' | 'list' | 'multiList' | 'Unknown'

The data type of a custom field definition's value.<p>Possible values:</p><ul><li><b>text</b>: Free text</li><li><b>number</b>: Numeric value (integer or decimal)</li><li><b>date</b>: Date only</li><li><b>dateTime</b>: Date and time</li><li><b>boolean</b>: Boolean value</li><li><b>list</b>: Single selection from a fixed list of values</li><li><b>multiList</b>: Multiple selections from a fixed list of values</li><li><b>unknown</b>: Fallback used when the underlying field type has no corresponding API vocabulary value</li></ul>

isRequiredboolean

Whether a value is expected for this custom field. This is informational - the service does not enforce it

isActiveboolean

Whether this custom field definition is currently active. Inactive (soft-deleted) definitions<br/>are still returned so consumers can resolve historical values, but should not be offered for new entries

displayOrderinteger

The position of this custom field relative to other custom fields on the same entity

Example response

{
  "id": 1234,
  "name": "Preferred contact time",
  "entityType": "contact",
  "fieldType": "text",
  "displayOrder": 1,
  "allowedValues": [
    {
      "id": 1,
      "value": "Red"
    }
  ]
}

Changes