v1

latestOpenAPI 3.1.1Proprietary2026-07-2687313591.4 KB
Companies

Get dropdown options for a Company Field

Returns the dropdown options for a specific dropdown or ranked-dropdown field on a Company.

Use the returned dropdown option IDs when writing dropdown field values via the field update endpoints.

get/v2/companies/fields/{fieldId}/dropdown-options

Path parameters

fieldIdstring required
Example:field-1234

Field ID

Query parameters

cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw

Cursor for the next or previous page

limitinteger

Number of items to include in the page

Response

OK

Example response

{
  "data": [
    {
      "id": 1,
      "text": "Active"
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}