Retrieve custom fields for organization | Deel

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

{
  "data": [
    {
      "id": "5926d8c4-e7d0-41db-9bec-b73d0de992bf",
      "name": "Department Budget",
      "type": "CURRENCY",
      "value": "USD50000.00",
      "raw_value": "50000.00",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-10T15:30:00.000Z",
      "is_inherited": true,
      "inherited_from": {
        "team_id": "5926d8c4-e7d0-41db-9bec-b73d0de992bf",
        "team_name": "Engineering Department"
      },
      "currency": "USD",
      "is_editable": true,
      "is_required": false
    },
    {
      "id": "a1b2c3d4-e5f6-4789-a012-b3c4d5e6f789",
      "name": "Department Type",
      "type": "LIST",
      "value": "Engineering",
      "raw_value": "Engineering",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-15T10:00:00.000Z",
      "is_inherited": false,
      "values": [
        "Engineering",
        "Sales",
        "Marketing",
        "HR"
      ],
      "is_editable": true,
      "is_required": true,
      "pending_change": {
        "value": "Sales",
        "status": "PENDING",
        "raw_value": "Sales",
        "is_approvable": false,
        "change_request_id": "a1b2c3d4-e5f6-4789-a012-b3c4d5e6f790",
        "edited_by": "Jane Smith",
        "requested_at": "2024-01-15",
        "effective_date": "2024-02-01",
        "approval_request_id": "b2c3d4e5-f6a7-4890-b123-c4d5e6f7a891",
        "modification_reason": "Department reorganization"
      }
    }
  ],
  "has_more": false,
  "total_count": 2
}

Retrieves custom field values for a specific organization structure (team). This endpoint returns all custom fields configured for organization structures, including their current values, inheritance status, and any pending change requests. Custom fields can be inherited from parent teams in the organizational hierarchy, and the response indicates whether each value is inherited or set directly on the specified team. If the user has permission to view data change requests, pending changes will also be included in the response. Token scopes: organizations:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

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)

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication