AFaffinity
Persons

Get dropdown options for a Person Field

Changed on
⚠️ This endpoint is currently in BETA

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

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

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

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/persons/fields/{fieldId}/dropdown-options
  • Auth
    HTTP bearer

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"
  }
}

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status

    • info

      added dropdown ranked-dropdown discriminator mapping keys to the / response property for the response status

    • info

      removed from the / response property oneOf list for the response status