Create a user | Deel | Documentation

curl -X POST https://api.letsdeel.com/scim/v2/Users \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "work@email.com",
  "name": {
    "familyName": "Jensen",
    "givenName": "Barbara"
  },
  "userType": "client"
}'

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

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.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -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

a new user without 'id'

schemaslist of enumsRequired

Schema URNs.

Allowed values:

userNamestringRequired

User's email.

nameobjectRequired

userTypeenumRequired

Type of user.

Allowed values:

Response

successfully created user

emailslist of objects

nameobject

schemaslist of enums

Allowed values:

userNamestring

User's work email.

activebooleanDefaults to false

Hiring status. True if user employment is active. False if employment is not active.

addresseslist of objects

idstring

Unique resource id (UUID) defined by Deel.

metaobject

Resource metadata.

titlestring

Job title.

urn:ietf:params:scim:schemas:extension:2.0:Userobject

urn:ietf:params:scim:schemas:extension:enterprise:2.0:Userobject

userTypestring

User type.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error

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