/requisitions/custom_attributes/:id/choices

Changed on

Returns the allowed choices of an enabled dropdown or multiple_choice requisition custom attribute, ordered by position. Required scope: r_requisitions. Accessible with all token types for accounts with Hiring Plan.

get/requisitions/custom_attributes/{id}/choices

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/requisitions/custom_attributes/{id}/choices
  • Auth
    API key in header Authorization

Path parameters

idstring required

The requisition custom attribute's id, as returned by /requisitions/custom_attributes

Query parameters

limitinteger

Specifies the number of choices to retrieve (optional). Defaults to 50, maximum 1000.

offsetinteger

Specifies the number of choices to skip (optional). Defaults to 0.

Response

200

totalinteger

The total number of choices of the attribute, regardless of limit and offset

Example response

{
  "choices": [
    {
      "id": "1227",
      "body": "Finance"
    }
  ],
  "total": 2
}

Changes