Skip to main content

Overview

There are a range of endpoints for accessing data which is custom to a specific CRM instance.

To access data from these endpoints customisations need to exist within the CRM instance. Please contact an account Manager if you have custom data you wish to add into CRM.

UserDefinedField

This endpoint will retrieve a list of custom data fields against standard CRM data entities.

The data in these fields can be retrieved, added or modified via the standard API endpoints. They will be available in a customFields array e.g. on /api/contacts/{serialnumber} GET and /api/contacts POST.

UserDefinedView

The GET will list availably custom views, these are custom read only views on your CRM data.

The /api/userdefinedview/{viewname} endpoint will access data from a given custom view. If you wish to filter the data use the optional parameters FilterColumn to specify which column to filter on & FilterValue for the filter criteria. Currently you may only filter on one column with a basic equality filter.

Entity Endpoints

The entity endpoints allow access to read custom data entity metadata.

  • Entity - Provides a list of custom entities & ability to get the details of a given custom entity
  • EntityField - Provides a list of custom entity fields & ability to get the details of a given custom entity field
  • EntityValidation - Provides a list of custom entity validations & ability to get the details of a given custom entity validation

EntityData​

This allows getting and posting of custom entity data. Posting data requires a JSON object in the correct format for the entity. To get the list of expected fields use the EntityField endpoints.