Get options for a custom field.

Request

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947

customFieldIdstring, (uuid)required

Identifier for custom field.

Example:4974a66b-7493-4f41-908c-58ba81093947

armIdstring, (uuid)required

Identifier for arm.

Example:4974a66b-7493-4f41-908c-58ba81093947

Bodyapplication/jsonrequired

paginationParamsobject(OffsetBasedPaginationRequestParams)required

Pagination parameters for requests.

nameSearchTextstring

Only the option that contain the specified text in name will be returned.

fetchEffectiveAdditionalInfosbooleanrequired

Indicates whether the additional infos should be fetched for each option from arm level if individual option does not have definition of additional infos.

Default:false

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/4974a66b-7493-4f41-908c-58ba81093947/custom-fields/4974a66b-7493-4f41-908c-58ba81093947/arms/4974a66b-7493-4f41-908c-58ba81093947/option-list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paginationParams": {
      "offset": 0,
      "limit": 100
    },
    "nameSearchText": "string",
    "fetchEffectiveAdditionalInfos": false
  }'

Responses

OK

Bodyapplication/json

paginationParamsobject(PaginationResponseParams)required

Pagination parameters for response.

optionsArray of objects(CustomFieldV3Option)

Response

{
  "paginationParams": {
    "totalNumResults": 0
  },
  "options": [
    { … }
  ]
}