Search or list users | Deel

{
  "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

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 -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
>   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## 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/

Request

search parameters

countintegerOptional

page size

filterstringOptional

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

schemaslist of enumsOptional

startIndexintegerOptional

start index (1-based)

Response

successful operation

Resourceslist of objects

User list.

itemsPerPagelong

schemaslist of enums

startIndexlong

Start index of the current page.

totalResultslong

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -X POST https://api.letsdeel.com/scim/v2/Users/.search \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

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