BAbamboohr
Custom Fields
Public API

List Archived Custom Fields

Changed on

Returns a paginated list of archived custom fields. IDs are strings and each has a numeric legacyId companion for legacy integrations. Use this for archived custom fields. For active custom fields, use List Custom Fields (list-custom-fields) instead.

OAuth Scopes: employee:custom_fields

get/api/v1/hris/custom-fields/archived

Request

Query parameters

pageinteger

Page number to retrieve. Must be greater than or equal to 1.

pageSizeinteger

Maximum number of archived custom fields to return per page.

Response

Paginated list of archived custom fields.

_linksobject nullable

Hypermedia links for collection navigation (next, prev) and available collection actions (e.g., create). Actions are permission-based and may vary.

Example response

{
  "meta": {
    "pageSize": 100,
    "totalPages": 1,
    "totalItems": 10
  },
  "_links": {
    "next": {
      "href": "/api/v1/reference-resources?page=2&pageSize=100"
    },
    "prev": {
      "href": "/api/v1/reference-resources?page=0&pageSize=100"
    }
  }
}

Changes