RErecruitwithatlas
Custom Attributes

List project custom attribute definitions

Changed on

Returns the custom attribute definitions (schema) configured for project records on this agency, including selectable options for dropdown-type attributes. options is deprecated: it lists every option unpaged — use GET /api/v1/projects/custom-attributes/{id}/options to page and search them.

Use this to discover which custom fields exist and what values are valid before reading or writing attribute data on project records.

get/api/v1/projects/custom-attributes

Request

Query parameters

pageinteger

Page number (1-indexed)

Example:1
pageSizeinteger

Items per page (max 100)

Example:25
perPageinteger

Alias for pageSize

Response

Paginated list of project custom attribute definitions

status'ok' required

Example response

{
  "data": [
    {
      "name": "Seniority Level",
      "description": "Candidate's seniority level",
      "type": "options",
      "multipleValues": true,
      "recordType": "contract",
      "options": [
        {
          "value": "Senior"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "total": 4,
    "totalPages": 1
  }
}

Changes