For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeel Home
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
  • Resources
    • Blog
    • Community
    • API spec
  • HRIS Guides
    • Introduction
  • HRIS Common Use Cases
    • Sync Deel users to identity providers
  • SCIM API
    • Overview
  • HRIS Endpoints
      • POSTCreate a new HRIS Organization Structure.
      • DELDelete an Org Structure from the Organization by external ID
      • DELDelete Organization Structure
      • GETFetch an Org Structure from the Organization
      • GETGet Organization Structure
      • GETGet Organization Structure
      • GETRetrieve custom fields for organization
      • PATCHUpdate an existing HRIS Org Structure by external ID
      • PUTUpdate organization structure
      • PATCHUpdate Organization Structure
      • PATCHUpdate organization structure team custom fields
  • ATS Guides
    • Introduction
    • Getting started
    • Manage jobs
    • Manage candidates and applications
    • Webhooks
  • ATS Common Use Cases
    • From candidate to contract
  • ATS Endpoints
LogoLogo
SupportDeel Home
HRIS EndpointsOrganization Structure

Retrieve custom fields for organization

GET
/hris/organization-structures/teams/:team_id/custom-fields
GET
/rest/v2/hris/organization-structures/teams/:team_id/custom-fields
$curl -G https://api.letsdeel.com/rest/v2/hris/organization-structures/teams/5926d8c4-e7d0-41db-9bec-b73d0de992bf/custom-fields \
>     -H "Authorization: Bearer <token>" \
>     -d limit=20 \
>     -d cursor=eyJsaW1pdCI6MjAsIm9mZnNldCI6MjB9
1{
2  "data": [
3    {
4      "id": "5926d8c4-e7d0-41db-9bec-b73d0de992bf",
5      "name": "Department Budget",
6      "type": "CURRENCY",
7      "value": "USD50000.00",
8      "raw_value": "50000.00",
9      "created_at": "2024-01-01T00:00:00.000Z",
10      "updated_at": "2024-01-10T15:30:00.000Z",
11      "is_inherited": true,
12      "inherited_from": {
13        "team_id": "5926d8c4-e7d0-41db-9bec-b73d0de992bf",
14        "team_name": "Engineering Department"
15      },
16      "currency": "USD",
17      "is_editable": true,
18      "is_required": false
19    },
20    {
21      "id": "a1b2c3d4-e5f6-4789-a012-b3c4d5e6f789",
22      "name": "Department Type",
23      "type": "LIST",
24      "value": "Engineering",
25      "raw_value": "Engineering",
26      "created_at": "2024-01-01T00:00:00.000Z",
27      "updated_at": "2024-01-15T10:00:00.000Z",
28      "is_inherited": false,
29      "inherited_from": null,
30      "values": [
31        "Engineering",
32        "Sales",
33        "Marketing",
34        "HR"
35      ],
36      "is_editable": true,
37      "is_required": true,
38      "pending_change": {
39        "value": "Sales",
40        "status": "PENDING",
41        "raw_value": "Sales",
42        "is_approvable": false,
43        "change_request_id": "a1b2c3d4-e5f6-4789-a012-b3c4d5e6f790",
44        "edited_by": "Jane Smith",
45        "requested_at": "2024-01-15",
46        "effective_date": "2024-02-01",
47        "approval_request_id": "b2c3d4e5-f6a7-4890-b123-c4d5e6f7a891",
48        "modification_reason": "Department reorganization"
49      }
50    }
51  ],
52  "has_more": false,
53  "next_cursor": null,
54  "total_count": 2
55}

Returns all custom field values configured for the specified team in the organizational hierarchy, including each field’s inheritance status (whether the value is set directly on the team or inherited from a parent), and any pending change requests visible to the caller. Token scopes: organizations:read

Was this page helpful?
Previous

Update an existing HRIS Org Structure by external ID

Next
Built with

Authentication

AuthorizationBearer
## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

team_idstringRequiredformat: "uuid"

Public ID (UUID) of the HRIS team/organization structure

Query parameters

limitintegerOptional<=100Defaults to 20

Max items per page (default 20, max 100)

cursorstringOptional
Opaque cursor for pagination

Response

Custom field values retrieved successfully
datalist of objects
Array of custom field values for the organization structure team
has_moreboolean
Whether more pages are available
next_cursorstring or null
Opaque cursor for the next page. Null if no more pages.
total_countinteger

Total number of custom field values (across all pages)

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

1curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/