RErecruitwithatlas
Custom Attributes

List the options of a project custom attribute

Changed on

Returns one page of the selectable options of an options-type custom attribute definition for project records, sorted by position. Pass search to return only options whose value contains it (case-insensitive).

Returns 404 if the attribute does not exist for this agency under this entity type, and 422 if it is not of type options.

get/api/v1/projects/custom-attributes/{id}/options

Request

Path parameters

idstring uuid required

Custom attribute definition identifier

Query parameters

searchstring

Only options whose value contains this text (case-insensitive)

Example:senior
pageinteger

Page number (1-indexed)

Example:1
pageSizeinteger

Items per page (max 100)

Example:25
perPageinteger

Alias for pageSize

Response

Paginated options of the project custom attribute

status'ok' required

Example response

{
  "data": [
    {
      "value": "Senior"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "total": 4,
    "totalPages": 1
  }
}

Changes