List users | Deel | Documentation

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "meta": {
        "created": "string",
        "location": "string",
        "lastModified": "string",
        "resourceType": "User"
      },
      "name": {
        "givenName": "string",
        "familyName": "string"
      },
      "emails": [
        {
          "type": "home",
          "value": "string",
          "primary": false
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "string",
      "id": "string",
      "title": "string",
      "active": false,
      "userType": "string",
      "addresses": [
        {
          "type": "string",
          "region": "string",
          "country": "string",
          "lineTwo": "string",
          "locality": "string",
          "postalCode": "string",
          "streetAddress": "string"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:2.0:User": {
        "state": "string",
        "country": "string",
        "endDate": "string",
        "birthday": "string",
        "workerId": "string",
        "isManager": false,
        "startDate": "string",
        "employments": [
          {
            "team": {
              "name": "string"
            },
            "state": "string",
            "title": "string",
            "active": false,
            "country": "string",
            "startDate": "string",
            "contractId": "string",
            "contractType": "string",
            "customFields": [
              {
                "id": "string",
                "data": {},
                "name": "string",
                "type": "string"
              }
            ],
            "employeeNumber": "string"
          }
        ],
        "customFields": [
          {
            "id": "string",
            "name": "string",
            "value": "string"
          }
        ],
        "hiringStatus": "string",
        "workLocation": "string",
        "preferredName": "string",
        "preferredLastName": "string",
        "preferredFirstName": "string",
        "departmentHierarchy": "string",
        "departmentExternalId": "string",
        "organizationalStructures": [
          {
            "name": "string",
            "externalId": "string",
            "structureId": "string",
            "nameHierarchy": "string",
            "structureName": "string",
            "externalIdHierarchy": "string"
          }
        ],
        "departmentExternalIdHierarchy": "string",
        "workerTerminationLastDateOfWork": "string"
      },
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "manager": {
          "value": "string",
          "email": "string",
          "displayName": "string"
        },
        "costCenter": "string",
        "department": "string",
        "customFields": {},
        "organization": "string",
        "preferredLastName": "string",
        "preferredFirstName": "string"
      }
    }
  ],
  "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

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"'.

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 enumsOptional

Allowed values:

Resourceslist of objectsOptional

startIndexlongOptional

itemsPerPagelongOptional

totalResultslongOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error