Fetch an Org Structure from the Organization | Deel

curl https://api.letsdeel.com/rest/v2/hris/organization_structures/external/rkkej3 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": {
    "id": "a3f47c9e-8b2d-4f6a-9c3e-1d2b5f7a9e4c",
    "name": "Acme Corporation",
    "type": "company",
    "roles": [
      {
        "id": 1,
        "name": "Administrator"
      },
      {
        "id": 2,
        "name": "Manager"
      },
      {
        "id": 3,
        "name": "Employee"
      }
    ],
    "teams": [
      {
        "id": "team-001",
        "name": "Engineering"
      },
      {
        "id": "team-002",
        "name": "Marketing"
      }
    ],
    "external_id": "rkkej3",
    "teams_count": 2,
    "enable_roles": true,
    "is_multiselect": true
  }
}

Fetches a single organization structure, returning associated roles and teams alongside structure metadata. 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/

Path parameters

external_idstringRequired

External ID

Response

Successful operation

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	{
2	"data": {
3	"id": "a3f47c9e-8b2d-4f6a-9c3e-1d2b5f7a9e4c",
4	"name": "Acme Corporation",
5	"type": "company",
6	"roles": [
7	{
8	"id": 1,
9	"name": "Administrator"
10	},
11	{
12	"id": 2,
13	"name": "Manager"
14	},
15	{
16	"id": 3,
17	"name": "Employee"
18	}
19	],
20	"teams": [
21	{
22	"id": "team-001",
23	"name": "Engineering"
24	},
25	{
26	"id": "team-002",
27	"name": "Marketing"
28	}
29	],
30	"external_id": "rkkej3",
31	"teams_count": 2,
32	"enable_roles": true,
33	"is_multiselect": true
34	}
35	}

1	{
2	"data": {
3	"id": "a3f47c9e-8b2d-4f6a-9c3e-1d2b5f7a9e4c",
4	"name": "Acme Corporation",
5	"type": "company",
6	"roles": [
7	{
8	"id": 1,
9	"name": "Administrator"
10	},
11	{
12	"id": 2,
13	"name": "Manager"
14	},
15	{
16	"id": 3,
17	"name": "Employee"
18	}
19	],
20	"teams": [
21	{
22	"id": "team-001",
23	"name": "Engineering"
24	},
25	{
26	"id": "team-002",
27	"name": "Marketing"
28	}
29	],
30	"external_id": "rkkej3",
31	"teams_count": 2,
32	"enable_roles": true,
33	"is_multiselect": true
34	}
35	}

$	curl https://api.letsdeel.com/rest/v2/hris/organization_structures/external/rkkej3 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

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