Skip to content
API reference
/
Custom fields
/
/
List arms

Custom Field API (v3)

Download OpenAPI description
CustomFieldApi.json
CustomFieldApi.yaml
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/customfieldapi

Custom Field V3

APIs to manage company custom fields.

Operations

Delete arm

Request

This endpoint deletes an arm.

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
curl -i -X DELETE \
  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 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Deleted Successfully

Response
No content

List arms

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
Bodyapplication/jsonrequired
searchTextstring

Search text to filter the ARMs.

filterobject(ListArmsFilter)
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/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchText": "string",
    "filter": {
      "tripUsageTypes": [
        "STANDARD"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
armsArray of objects(Arm)
Response
application/json
{
  "arms": [
    { … }
  ]
}

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.

paginationParams.​offsetinteger(int32)>= 0

The starting index in the list from which results are returned. The value must be greater than or equal to 0.

Default 0
paginationParams.​limitinteger(int32)>= 1

Maximum number of results to be fetched.

Default 100
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(OffsetBasedPaginationResponseParams)required

Pagination parameters for response.

paginationParams.​totalNumResultsinteger(int32)required

Total number of results.

optionsArray of objects(CustomFieldV3Option)
Response
application/json
{
  "paginationParams": {
    "totalNumResults": 0
  },
  "options": [
    { … }
  ]
}
Copyright © 2026 Spotnana Technology, Inc.