List users | Deel | Documentation

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "meta": {
        "created": "2023-11-15T09:30:00Z",
        "location": "https://api.letsdeel.com/scim/v2/Users/a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
        "lastModified": "2024-05-20T14:45:00Z",
        "resourceType": "User"
      },
      "name": {
        "givenName": "Emily",
        "familyName": "Johnson"
      },
      "emails": [
        {
          "type": "work",
          "value": "emily.johnson@deel.com",
          "primary": true
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "ejohnson",
      "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "title": "Senior Software Engineer",
      "active": true,
      "userType": "Employee",
      "addresses": [
        {
          "type": "work",
          "region": "California",
          "country": "US",
          "lineTwo": "Suite 400",
          "locality": "San Francisco",
          "postalCode": "94105",
          "streetAddress": "123 Market St"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:2.0:User": {
        "state": "California",
        "country": "US",
        "endDate": "2025-12-31",
        "birthday": "1990-04-15",
        "workerId": "W123456",
        "isManager": false,
        "startDate": "2020-06-01",
        "employments": [
          {
            "team": {
              "name": "Platform Engineering"
            },
            "state": "California",
            "title": "Senior Software Engineer",
            "active": true,
            "country": "US",
            "startDate": "2020-06-01",
            "contractId": "C78910",
            "contractType": "Full-time",
            "customFields": [
              {
                "id": "CF001",
                "data": {
                  "value": "Agile"
                },
                "name": "Work Methodology",
                "type": "Text"
              }
            ],
            "employeeNumber": "E456789"
          }
        ],
        "customFields": [
          {
            "id": "CF100",
            "name": "Employee Level",
            "value": "Senior"
          }
        ],
        "hiringStatus": "Active",
        "workLocation": "San Francisco HQ",
        "preferredName": "Em",
        "preferredLastName": "Johnson",
        "preferredFirstName": "Emily",
        "departmentHierarchy": "Engineering > Platform",
        "departmentExternalId": "DPT123",
        "organizationalStructures": [
          {
            "name": "Engineering",
            "externalId": "ENG001",
            "structureId": "STR1001",
            "nameHierarchy": "Company > Engineering",
            "structureName": "Engineering Division",
            "externalIdHierarchy": "COMP001>ENG001"
          }
        ],
        "departmentExternalIdHierarchy": "COMP001>ENG001>DPT123",
        "workerTerminationLastDateOfWork": null
      },
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "manager": {
          "value": "michael.smith",
          "email": "michael.smith@deel.com",
          "displayName": "Michael Smith"
        },
        "costCenter": "CC1001",
        "department": "Platform Engineering",
        "customFields": {
          "EmployeeBadge": "12345",
          "ParkingSpot": "B12"
        },
        "organization": "Deel Inc.",
        "preferredLastName": "Johnson",
        "preferredFirstName": "Emily"
      },
      "phoneNumbers": [
        {
          "type": "work",
          "value": "+14155552671",
          "primary": true
        }
      ]
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 1,
  "totalResults": 1
}

Retrieve a list of users in Deel’s HRIS. Token scopes: Users: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 -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/

Query parameters

filterstring or list of stringsOptional

Filter results using SCIM’s filtering syntax. Currently supports only eq operator and filtering by a user’s email. Expected format ‘email eq “email@domain.com”’.

Filter results using [SCIM's filtering syntax](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2). Currently supports only `eq` operator and filtering by a user's email. Expected format 'email eq "email@domain.com"'.

startIndexstringOptionalformat: "^[0-9]+$"

The 1-based index of the first result to return. Used for pagination. Minimum value is 1. Defaults to 1 if not provided.

countstringOptionalformat: "^[0-9]+$"

The maximum number of results to return per page. Used for pagination. A value of 0 is treated as a special case and returns 1 result. Typically should be a positive integer.

Response

Successful response

schemaslist of enums

Resourceslist of objects

startIndexlong

itemsPerPagelong

totalResultslong

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -G https://api.letsdeel.com/scim/v2/Users \
>	-H "Authorization: Bearer <token>" \
>	--data-urlencode "filter=email eq "user@example.com"" \
>	-d startIndex=1 \
>	-d count=50

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