List users | Deel | Documentation

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

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "meta": {
        "created": "2023-11-01T09:15: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@letsdeel.com",
          "primary": true
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "emily.johnson",
      "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": "C789012",
            "contractType": "full-time",
            "employeeNumber": "E456789"
          }
        ],
        "customFields": [
          {
            "id": "CF001",
            "name": "Employee Level",
            "value": "L5"
          }
        ],
        "hiringStatus": "active",
        "preferredName": "Em",
        "preferredLastName": "Johnson",
        "preferredFirstName": "Emily",
        "departmentHierarchy": "Engineering > Software Development",
        "departmentExternalId": "DPT1001",
        "organizationalStructures": [
          {
            "name": "Engineering",
            "externalId": "ENG001",
            "structureId": "STR123",
            "nameHierarchy": "Company > Engineering",
            "structureName": "Engineering Division",
            "externalIdHierarchy": "COMP001>ENG001"
          }
        ],
        "departmentExternalIdHierarchy": "COMP001>ENG001>DPT1001",
        "workerTerminationLastDateOfWork": null
      },
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "manager": {
          "value": "michael.smith",
          "email": "michael.smith@letsdeel.com",
          "displayName": "Michael Smith"
        },
        "costCenter": "CC1001",
        "department": "Software Development",
        "customFields": {
          "EmployeeBadgeNumber": "B12345"
        },
        "organization": "Deel Inc.",
        "preferredLastName": "Johnson",
        "preferredFirstName": "Emily"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 1,
  "totalResults": 1
}

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

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 or null

Allowed values:

Resourceslist of objects or null

startIndexlong or null

itemsPerPagelong or null

totalResultslong or null

Authentication

Authentication

Query parameters

Response

Errors

Authentication