Get Organization Structure | Deel

curl https://api.letsdeel.com/rest/v2/hris/organization_structures \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "Engineering",
      "type": "department",
      "roles": [
        {
          "id": "85b54219-8456-4072-bee8-71e2d88452fa",
          "name": "Software Engineer"
        }
      ],
      "teams": [
        {
          "id": "ba46af84-2f15-42f3-b171-d7d9e0abb274",
          "name": "Software Engineer",
          "parent": "Business",
          "children": [
            {}
          ],
          "created_at": "2023-10-01T12:00:00Z",
          "name_route": "software-engineer",
          "external_id": "ba46af84-2f15-42f3-b171-d7d9e0abb274"
        }
      ],
      "created_at": "2023-10-01T12:00:00Z",
      "external_id": "engineering",
      "teams_count": 3,
      "enable_roles": true,
      "is_multiselect": false
    }
  ]
}

Returns the organization’s hierarchical structure, including departments and teams, with offset-based pagination. Token scopes: organizations:read

curl https://api.letsdeel.com/rest/v2/hris/organization_structures \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "Engineering",
      "type": "department",
      "roles": [
        {
          "id": "85b54219-8456-4072-bee8-71e2d88452fa",
          "name": "Software Engineer"
        }
      ],
      "teams": [
        {
          "id": "ba46af84-2f15-42f3-b171-d7d9e0abb274",
          "name": "Software Engineer",
          "parent": "Business",
          "children": [
            {}
          ],
          "created_at": "2023-10-01T12:00:00Z",
          "name_route": "software-engineer",
          "external_id": "ba46af84-2f15-42f3-b171-d7d9e0abb274"
        }
      ],
      "created_at": "2023-10-01T12:00:00Z",
      "external_id": "engineering",
      "teams_count": 3,
      "enable_roles": true,
      "is_multiselect": false
    }
  ]
}

Returns the organization’s hierarchical structure, including departments and teams, with offset-based pagination. Token scopes: organizations:read

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)

AuthorizationBearer

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

Query parameters

offsetlongOptionalDefaults to 0

Return a page of results with given number of records.

limitdoubleOptional1-200

Return a page of results with given number of records.

Response

Successful operation

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.letsdeel.com/rest/v2/hris/organization_structures \
>	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
5	"name": "Engineering",
6	"type": "department",
7	"roles": [
8	{
9	"id": "85b54219-8456-4072-bee8-71e2d88452fa",
10	"name": "Software Engineer"
11	}
12	],
13	"teams": [
14	{
15	"id": "ba46af84-2f15-42f3-b171-d7d9e0abb274",
16	"name": "Software Engineer",
17	"parent": "Business",
18	"children": [
19	{}
20	],
21	"created_at": "2023-10-01T12:00:00Z",
22	"name_route": "software-engineer",
23	"external_id": "ba46af84-2f15-42f3-b171-d7d9e0abb274"
24	}
25	],
26	"created_at": "2023-10-01T12:00:00Z",
27	"external_id": "engineering",
28	"teams_count": 3,
29	"enable_roles": true,
30	"is_multiselect": false
31	}
32	]
33	}

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