Search or list users | Deel

import requests
url = "https://api.letsdeel.com/scim/v2/Users/.search"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "Resources": [
    {
      "emails": [
        {
          "type": "work",
          "value": "work.email@example.com",
          "primary": true
        }
      ],
      "name": {
        "familyName": "Doe",
        "givenName": "Jane"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "work.email@example.com",
      "active": false,
      "addresses": [
        {
          "streetAddress": "Deel Street 500",
          "locality": "Denver",
          "region": "CO",
          "postalCode": "44000",
          "country": "AD",
          "type": "work"
        }
      ],
      "id": "97b727b8-bdb5-11ed-afa1-0242ac120002",
      "meta": {
        "created": "2024-01-15T09:30:00Z",
        "lastModified": "2024-01-15T09:30:00Z",
        "location": "string",
        "resourceType": "User"
      },
      "title": "Software Engineer",
      "urn:ietf:params:scim:schemas:extension:2.0:User": {
        "preferredFirstName": "John",
        "preferredLastName": "Doe",
        "preferredName": "John Doe",
        "workerId": 1.1,
        "startDate": "2024-01-15T09:30:00Z",
        "endDate": "2024-01-15T09:30:00Z",
        "birthday": "string",
        "hiringStatus": "active",
        "state": "CO",
        "country": "US",
        "employments": [
          {
            "contractId": "av4bt56",
            "title": "International Factors Developer",
            "startDate": "2023-04-26",
            "contractType": "eor",
            "active": true,
            "state": "CO",
            "country": "US",
            "team": {}
          }
        ],
        "customFields": [
          {
            "id": "b29a5ff0-bdb5-11ed-afa1-0242ac120002",
            "name": "Nickname",
            "value": "Barbara"
          }
        ],
        "organizationalStructures": [
          {
            "structureId": "642b0547-9d80-4d35-a085-dg377ef209d3",
            "structureName": "Nickname",
            "nameHierarchy": "Administration / HR / Recruitment",
            "name": "Recruitment",
            "externalId": "642b0547-9d80-4d35-a085-fd977ef209d3",
            "externalIdHierarchy": "642b0547-9d80-4d35-a085-fd977ef209d3 / 642b0547-9d80-4d35-a085-fd977ef209b2"
          }
        ],
        "isManager": true,
        "departmentHierarchy": "Engineering / Backend / SCIM",
        "departmentExternalId": "642b0547-9d80-4d35-a085-fd977ef209ef",
        "departmentExternalIdHierarchy": "642b0547-9d80-4d35-a085-fd977ef209ef / 642b0547-9d80-4d35-a085-fd977ef209d3"
      },
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Engineering",
        "costCenter": "12345",
        "organization": "45321",
        "manager": {
          "value": "b29a5ff0-bdb5-11ed-afa1-0242ac120002",
          "displayName": "John Doe",
          "email": "john@example.com"
        }
      },
      "userType": "employee"
    }
  ],
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 1
}

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/

Request

search parameters

countintegerOptional

page size

filterstringOptional

only support 'userName' or 'email' filter expressions for now

schemaslist of enumsOptional

Allowed values:

startIndexintegerOptional

start index (1-based)

Response

successful operation

Resourceslist of objects or null

User list.

itemsPerPagelong or null

schemaslist of enums or null

Allowed values:

startIndexlong or null

Start index of the current page.

totalResultslong or null

Authentication

Authentication

Request

Response

Errors

Authentication