Retrieve a list of business fields (get-all) - Ortto Knowledge Base

The get-all Ortto endpoint of the business-fields entity is used to retrieve a list of the system and custom business fields in Ortto’s customer data platform (CDP).

This page provides descriptions of this endpoint’s:

request resource and method,
valid parameters, headers, and request body values, as well as
the response payload.

HTTP method and request resources

Get Business fields endpoint


 POST https://api.ap3api.com/v1/business-fields/get-all

NOTE: Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:

Australia: https://api.au.ap3api.com/
Europe: https://api.eu.ap3api.com/

For example: https://api.eu.ap3api.com/v1/<entity/endpoint>

All other Ortto users will use the default service endpoint (https://api.ap3api.com/).

Path and query parameters

This endpoint takes no additional path and/or query parameters.

Headers

This endpoint requires a custom API key and content type (application/json for the request body) in the header of the request:

X-Api-Key: CUSTOM-PRIVATE-API-KEY
Content-Type: application/json

Request body

This endpoint does not take a request body.

Response payload

The response payload consists of a JSON object with the elements listed in the table below.

The following JSON object is an example of the business fields data that Ortto retrieves from your Ortto account’s CDP after a request to this endpoint.

Example get business fields payload from Ortto’s CDP

json
   {        
      "str:$b$:cn": {
              "field_id": "str:$b$:cn",
              "name": "Company Name",
              "liquid_name": "business.company-name",
              "display_type": "text",
              "value": "Pitcha",
              "is_system": true, 
              "read_only": false
          },    
      "str:$b$:ea": {
              "field_id": "str:$b$:ea",
              "name": "Address",
              "liquid_name": "business.address",
              "display_type": "text",
              "value": "123 Short St",
              "is_system": true,
              "read_only": false
          },
      "str:$b$:lu": {
              "field_id": "str:$b$:lu",
              "name": "Logo URL", 
              "liquid_name": "business.logo-url",
              "display_type": "url",
              "value": "",
              "is_system": true,
              "read_only": true
          },
      "str:$b$:w": {
              "field_id": "str:$b$:w",
              "name": "Website",
              "liquid_name": "business.website",
              "display_type": "text",
              "value": "http://pitcha.com",
              "is_system": true,
              "read_only": false
          }
  }

This endpoint will also return any social links or custom business fields you have added to your account.

Response payload elements

The following table lists all elements (arrays, objects, or fields) in the response from a request to this endpoint.

The response is an array of field objects, the elements of the field object is included below.

Element	Type	Description
`field_id`	`string`	The identifier for the field name in Ortto’s custom field ID format.
`name`	`string`	The name specified for the field when it was created or the system-assigned name.
`liquid_name`	`string`	The Liquid language tag for the field.
`display_type`	`string`	The name of the field type. See a list of field types under Request body in Create a custom field (create).
`value`	`string`	The value currently assigned to this field.
`is_system`	`bool`	Whether this field is a system field (includes social links). If false, the field is custom.
`read_only`	`bool`	If this field can be updated via the API. If false, the field can only be updated in the Ortto app.