Fetch Worker Relations of a given HrisProfile by external id | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/hris/worker_relations/profile/external/f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b",
      "name": "Parent",
      "is_parent": true,
      "is_default": true,
      "child_relationships": [
        {
          "last_name": "Doe",
          "first_name": "John",
          "profile_id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b",
          "external_id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b",
          "relation_id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b"
        }
      ],
      "parent_relationship": {
        "last_name": "Doe",
        "first_name": "Jane",
        "profile_id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b",
        "relation_id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b",
        "profile_external_id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b",
        "relation_external_id": "f7b3b2b3-6b1b-4b3b-8b3b-3b3b3b3b3b3b"
      }
    }
  ]
}

Fetch Worker Relations of a given HrisProfile by external id. Token scopes: profile: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

profileIdstringRequired

HrisProfile external ID

Response

Successful operation

datalist of objects or null

An array containing the Worker Relations of the profile. It includes either the parent or child relations.

Authentication

Authentication

Path parameters

Response

Errors

Authentication