Skip to content

List custom field

Request

Security
Bearer
Path
companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947
Query
companyRolestring(CompanyRole)required

Role of the company.

Enum:"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"
Example:companyRole=ORG
Bodyapplication/jsonrequired
paginationParamsobject(OffsetBasedPaginationRequestParams)required

Pagination parameters for requests.

searchTextstring

Search text to filter the custom fields.

filterobject(ListCustomFieldFilter)
curl -i -X POST \
  'https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/4974a66b-7493-4f41-908c-58ba81093947/custom-fields/list?companyRole=ORG' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paginationParams": {
      "offset": 0,
      "limit": 100
    },
    "searchText": "string",
    "filter": {
      "definedAtList": [
        "ORG"
      ],
      "enabled": true,
      "customFieldIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "tripUsageTypes": [
        "STANDARD"
      ],
      "captureSteps": [
        "AT_CHECKOUT"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
paginationParamsobject(PaginationResponseParams)

Pagination parameters for response.

fieldsArray of objects(CustomFieldInfo)

List of custom field info

Response
{ "paginationParams": { "totalNumResults": 0 }, "fields": [ { … } ] }