Users

Update user application access

Adds or removes access to one Skillhabit application for the user. action controls whether the selected application is added or removed. Supported applicationId values are achievements, analyse, create, learn, and follow-up.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose application access should be updated.

action*string

Access update action.

Value in

"ADD"
"REMOVE"

Request Body

application/json

Application access request.

TypeScript Definitions

Use the request body type in TypeScript.

Request to grant or revoke access to one Skillhabit application.

applicationId?string

Application access identifiers that can be granted through the external API.

Value in

"ACHIEVEMENTS"
"ANALYSE"
"CREATE"
"LEARN"
"FOLLOW_UP"

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/access/ADD" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Archive user

Archives a user account. Admin users cannot be archived and return a bad request.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id to archive.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/archive"

Empty

List users

Returns users for the customer. Use filter to search by user fields supported by the user service; an empty filter returns all users. The response includes resolved custom field names and pagination metadata.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Query Parameters

filter?string

Search filter. Empty string returns all users.

Default""

skip?integer

Number of matching users to skip.

Formatint32

Default0

limit?integer

Maximum number of users to return.

Formatint32

Default100

Response Body

`application/json`

curl -X GET "https://example.com/users?filter=alice&skip=0&limit=100"

{  "users": [    {      "userId": "7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01",      "email": "employee@example.com",      "firstName": "string",      "lastName": "string",      "avatarUrl": "string",      "customFields": {        "property1": {},        "property2": {}      },      "emailStatus": "string",      "metadata": {        "property1": "string",        "property2": "string"      },      "archivedAt": 1700000000000,      "customArchiveDate": 1750000000000    }  ],  "skip": 0,  "limit": 100,  "filter": "string",  "matchCount": 250}

Create user

Creates a user account for the customer. The request may include name, language, and whether a welcome email should be sent.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Request Body

application/json

User creation request.

TypeScript Definitions

Use the request body type in TypeScript.

Create user request.

email?string

Email address of the user to create.

firstName?|

First name. Optional.

lastName?|

Last name. Optional.

language?string

Supported user language values. Each enum maps to the lowercase language code used by Skillhabit.

Value in

"EN"
"SV"
"DE"
"ES"
"FI"
"FR"
"LT"
"NL"
"NO"
"PL"
"RU"
"UK"
"DA"
"RO"
"ET"
"AR"
"FA"
"SO"
"ZH_CN"
"ZH_TW"

sendWelcomeEmail?boolean

Whether to send a welcome email when the user is created.

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/users" \  -H "Content-Type: application/json" \  -d '{}'

{  "userId": "7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01",  "newUser": true}

Get user

Returns one user account with profile fields, metadata, custom fields, integrations, and current group membership information.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id to retrieve.

Response Body

`application/json`

curl -X GET "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01"

{  "userId": "7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01",  "email": "employee@example.com",  "firstName": "string",  "lastName": "string",  "avatarUrl": "string",  "customFields": {    "property1": {},    "property2": {}  },  "emailStatus": "string",  "language": "en",  "lastLoginAt": 0,  "admin": true,  "manager": true,  "applicationIds": [    "string"  ],  "metadata": {    "property1": "string",    "property2": "string"  },  "createdAt": 1700000000000,  "timeZone": {    "displayName": "string",    "id": "string",    "dstsavings": 0,    "rawOffset": 0  },  "integrationIds": {    "property1": "string",    "property2": "string"  },  "archivedAt": 0,  "scheduledDeleteDate": 0,  "customArchiveDate": 0,  "memberOfGroups": [    {      "groupId": "7d6b7a10-2b2a-4a30-8a2e-39ad8e4f2b11",      "groupType": "string",      "name": "string"    }  ],  "managerOfGroups": [    {      "groupId": "7d6b7a10-2b2a-4a30-8a2e-39ad8e4f2b11",      "groupType": "string",      "name": "string"    }  ]}

Delete user

Deletes a user account by id.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id to delete.

Response Body

`application/json`

curl -X DELETE "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01"

Empty

List certificates for users

Returns certificates for the selected users. Use flatView=true to request the downstream flat response shape; omit it for the grouped-by-user response.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Query Parameters

userIds[]?array<string>

User ids whose certificates should be returned.

flatView?boolean

When true, returns the downstream flat certificate view instead of the grouped user view.

Response Body

`application/json`

curl -X GET "https://example.com/users/certificates?userIds%5B%5D=7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01&flatView=false"

{  "usersWithCertificates": {    "property1": {      "contentId": "d69c7cd1-9943-4f7f-b95f-0572b3458e9c",      "contentType": "COURSE",      "contentName": "string",      "certificateId": "e2d2a9c7-5349-4ca7-a1dc-7c1b2a3e4f50",      "issued": 1700000000000,      "pdfUri": "string",      "status": "ACTIVE",      "recertificationContentId": "string",      "expiresAt": 1731536000000,      "certificateAttachment": "string",      "certificateAttachments": [        {          "url": "string",          "name": "string",          "createdAt": 1700000000000        }      ],      "recertificationCertificate": {        "contentId": "d69c7cd1-9943-4f7f-b95f-0572b3458e9c",        "contentType": "COURSE",        "contentName": "string",        "certificateId": "e2d2a9c7-5349-4ca7-a1dc-7c1b2a3e4f50",        "issued": 0,        "pdfUri": "string",        "status": "ACTIVE",        "recertificationContentId": "string",        "expiresAt": 0,        "certificateAttachment": "string",        "certificateAttachments": [          {            "url": "string",            "name": "string",            "createdAt": 1700000000000          }        ],        "expiredNotificationEnabled": true      },      "expiredNotificationEnabled": true    },    "property2": {      "contentId": "d69c7cd1-9943-4f7f-b95f-0572b3458e9c",      "contentType": "COURSE",      "contentName": "string",      "certificateId": "e2d2a9c7-5349-4ca7-a1dc-7c1b2a3e4f50",      "issued": 1700000000000,      "pdfUri": "string",      "status": "ACTIVE",      "recertificationContentId": "string",      "expiresAt": 1731536000000,      "certificateAttachment": "string",      "certificateAttachments": [        {          "url": "string",          "name": "string",          "createdAt": 1700000000000        }      ],      "recertificationCertificate": {        "contentId": "d69c7cd1-9943-4f7f-b95f-0572b3458e9c",        "contentType": "COURSE",        "contentName": "string",        "certificateId": "e2d2a9c7-5349-4ca7-a1dc-7c1b2a3e4f50",        "issued": 0,        "pdfUri": "string",        "status": "ACTIVE",        "recertificationContentId": "string",        "expiresAt": 0,        "certificateAttachment": "string",        "certificateAttachments": [          {            "url": "string",            "name": "string",            "createdAt": 1700000000000          }        ],        "expiredNotificationEnabled": true      },      "expiredNotificationEnabled": true    }  }}

List custom fields for user updates

Deprecated

Deprecated compatibility endpoint that returns the customer's available custom fields for older user custom-field update clients. Prefer GET /custom-fields.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Response Body

`application/json`

curl -X GET "https://example.com/users/custom-field-choice"

{  "customFields": [    {      "customFieldId": "22576317-111e-4373-9d27-b04469f360d3",      "id": "22576317-111e-4373-9d27-b04469f360d3",      "type": "CHOICE",      "name": "Department",      "choices": [        {          "choiceId": "8a9064d1-2226-41e1-b203-33a42063c251",          "name": "Sales"        }      ]    }  ]}

List user certificates

Returns certificates issued to one user.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose certificates should be returned.

Response Body

`application/json`

curl -X GET "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/certificates"

{  "userId": "7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01",  "certificates": [    {      "contentId": "d69c7cd1-9943-4f7f-b95f-0572b3458e9c",      "contentType": "COURSE",      "contentName": "string",      "certificateId": "e2d2a9c7-5349-4ca7-a1dc-7c1b2a3e4f50",      "issued": 1700000000000,      "pdfUri": "string",      "status": "ACTIVE",      "recertificationContentId": "string",      "expiresAt": 1731536000000,      "certificateAttachment": "string",      "certificateAttachments": [        {          "url": "string",          "name": "string",          "createdAt": 1700000000000        }      ],      "recertificationCertificate": {        "contentId": "d69c7cd1-9943-4f7f-b95f-0572b3458e9c",        "contentType": "COURSE",        "contentName": "string",        "certificateId": "e2d2a9c7-5349-4ca7-a1dc-7c1b2a3e4f50",        "issued": 0,        "pdfUri": "string",        "status": "ACTIVE",        "recertificationContentId": "string",        "expiresAt": 0,        "certificateAttachment": "string",        "certificateAttachments": [          {            "url": "string",            "name": "string",            "createdAt": 1700000000000          }        ],        "expiredNotificationEnabled": true      },      "expiredNotificationEnabled": true    }  ]}

Get user order details

Returns Academy order/contact details stored for a user. These values are used when creating content purchase orders.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose order details should be returned.

Response Body

`application/json`

curl -X GET "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/order-details"

{  "disablePayment": false,  "email": "string",  "firstName": "string",  "lastName": "string",  "companyName": "string",  "companyNumber": "string",  "companyEmail": "string",  "phone": "string",  "phoneCode": "string",  "address": {    "street": "string",    "city": "string",    "country": "string",    "phone": "string",    "zip": "string"  },  "companyPayment": false,  "note": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update user order details

Updates Academy order/contact details for a user.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose order details should be updated.

Request Body

application/json

Order/contact fields to store for the user.

TypeScript Definitions

Use the request body type in TypeScript.

Request body for updating user order/contact details.

email?string

Contact email used for purchase/order flows.

firstName?string

Contact first name.

lastName?string

Contact last name.

companyName?string

Company name used for invoice/company purchases.

companyNumber?string

Company registration number.

companyEmail?string

Company email address.

phone?|

Phone number without country code.

phoneCode?|

Phone country/area code.

address?

Postal/contact address.

companyPayment?boolean

Whether company payment is enabled for the user.

Defaultfalse

note?string

Free-text note stored with the order details.

Response Body

`application/json`

curl -X PUT "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/order-details" \  -H "Content-Type: application/json" \  -d '{}'

{  "disablePayment": false,  "email": "string",  "firstName": "string",  "lastName": "string",  "companyName": "string",  "companyNumber": "string",  "companyEmail": "string",  "phone": "string",  "phoneCode": "string",  "address": {    "street": "string",    "city": "string",    "country": "string",    "phone": "string",    "zip": "string"  },  "companyPayment": false,  "note": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List users with groups

Returns users with manual/smart group memberships, manager groups, and available application permissions. Use filter to search; an empty filter returns all users.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Query Parameters

filter?string

Search filter. Empty string returns all users.

Default""

skip?integer

Number of matching users to skip.

Formatint32

Default0

limit?integer

Maximum number of users to return.

Formatint32

Default100

Response Body

`application/json`

curl -X GET "https://example.com/users/extended-info?filter=alice&skip=0&limit=100"

{  "users": [    {      "userId": "7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01",      "email": "employee@example.com",      "firstName": "string",      "lastName": "string",      "avatarUrl": "string",      "emailStatus": "string",      "admin": true,      "manager": true,      "memberOfGroups": [        {          "groupId": "7d6b7a10-2b2a-4a30-8a2e-39ad8e4f2b11",          "groupType": "string",          "name": "string"        }      ],      "managerOfGroups": [        {          "groupId": "7d6b7a10-2b2a-4a30-8a2e-39ad8e4f2b11",          "groupType": "string",          "name": "string"        }      ],      "availableApplications": [        "string"      ]    }  ],  "skip": 0,  "limit": 100,  "filter": "string",  "matchCount": 250}

Set user admin access

Grants or revokes administrator rights for a user. Use endow=true to grant admin access and endow=false to revoke it.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose admin access should be updated.

endow*boolean

true grants admin access; false revokes admin access.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/make-admin/true"

Empty

Set user manager access

Grants or revokes manager rights for a user. Use endow=true to grant manager access and endow=false to revoke it.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose manager access should be updated.

endow*boolean

true grants manager access; false revokes manager access.

Response Body

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/make-manager/true"

Empty

Search users with advanced filtering

Search for users in the system with advanced filtering capabilities. This endpoint supports filtering by text search (searches in user name or email), metadata key-value pairs, pagination (skip/limit), and optionally includes group information and application permissions. The metadata parameter allows filtering users based on custom metadata stored as key-value pairs. When includeGroups is set to true, the response will include group memberships for each user.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Request Body

application/json

Advanced search request. Use includeGroups=true to include group memberships and application access.

TypeScript Definitions

Use the request body type in TypeScript.

Advanced user search request.

textSearch?|

Text search against user name or email. Omit or null to skip text filtering.

skip?integer

Number of matching users to skip.

Formatint32

Default0

limit?integer

Maximum number of users to return.

Formatint32

Default100

metadata?|

Customer-defined metadata key/value filters. Keys and expected values depend on the customer's user metadata.

includeGroups?boolean

When true, include group memberships, manager groups, and available applications in each user result.

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/users/search" \  -H "Content-Type: application/json" \  -d '{}'

{  "users": [    {      "userId": "7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01",      "email": "employee@example.com",      "firstName": "string",      "lastName": "string",      "avatarUrl": "string",      "customFields": {        "property1": {},        "property2": {}      },      "emailStatus": "string",      "metadata": {        "property1": "string",        "property2": "string"      },      "admin": true,      "manager": true,      "memberOfGroups": [        {          "groupId": "7d6b7a10-2b2a-4a30-8a2e-39ad8e4f2b11",          "groupType": "string",          "name": "string"        }      ],      "managerOfGroups": [        {          "groupId": "7d6b7a10-2b2a-4a30-8a2e-39ad8e4f2b11",          "groupType": "string",          "name": "string"        }      ],      "availableApplications": [        "string"      ]    }  ],  "matchCount": 250}

Set custom archived date

Set a custom date when the user account will be archived. Pass null date to reset the custom archived date. Admin or manager users can not have a custom archived date.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose custom archive date should be updated.

Request Body

application/json

Custom archive date in epoch milliseconds, or null to clear it.

TypeScript Definitions

Use the request body type in TypeScript.

Custom archive date update request.

date?|

Timestamp when the user should be archived, in epoch milliseconds. Send null to clear the custom date.

Formatint64

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/set-custom-archived-date" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Unarchive user

Unarchive a previously archived user account.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id to unarchive.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/unarchive"

Empty

Update user custom fields

Updates custom field answers on a user account. The request shape is forwarded to the user service and contains custom-field ids mapped to selected values.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose custom fields should be updated.

Request Body

application/json

Custom field answers for the user. Keys and allowed values depend on the customer's custom field definitions.

TypeScript Definitions

Use the request body type in TypeScript.

User custom field answer update request.

customFieldId?string

Custom field id to update.

choiceId?|

Choice id for CHOICE fields. Mutually exclusive with answer and choiceIds.

answer?|

Text answer for TEXT fields. Mutually exclusive with choiceId and choiceIds.

choiceIds?array<|>|

Choice ids for MULTI_SELECT fields. Mutually exclusive with choiceId and answer.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/update-custom-field-choice" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Update user email

Changes the email address of a user account after validating the email format.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose email should be updated.

Request Body

application/json

New email address.

TypeScript Definitions

Use the request body type in TypeScript.

Email update request.

email*string

New email address for the user.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/update-email" \  -H "Content-Type: application/json" \  -d '{    "email": "new.email@example.com"  }'

Empty

Update user name

Updates the first and/or last name of a user account.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose name should be updated.

Request Body

application/json

First and last name values to store on the user.

TypeScript Definitions

Use the request body type in TypeScript.

User name update request.

firstName*string

New first name.

lastName*string

New last name.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/update-fullname" \  -H "Content-Type: application/json" \  -d '{    "firstName": "Alice",    "lastName": "Example"  }'

Empty

Update user language

Updates the user's preferred language. The language code must be one of the supported lowercase language codes, such as en, sv, de, no, nl, fi, uk, or es.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose language should be updated.

Request Body

application/json

New preferred language code.

TypeScript Definitions

Use the request body type in TypeScript.

Language update request.

language*string

Lowercase language code.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/update-language" \  -H "Content-Type: application/json" \  -d '{    "language": "en"  }'

Empty

Update user metadata

Replaces or updates customer-defined metadata on a user account. Metadata keys and values are customer-specific strings.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose metadata should be updated.

Request Body

application/json

Metadata key/value pairs to store on the user.

TypeScript Definitions

Use the request body type in TypeScript.

Metadata update request.

metadata*

Customer-defined metadata key/value pairs to store on the user.

Response Body

`application/json`

curl -X POST "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/update-metadata" \  -H "Content-Type: application/json" \  -d '{    "metadata": {      "property1": "string",      "property2": "string"    }  }'

Empty

Disable payment for user

Enables or disables payment access for one user in Academy purchase flows.

Authorization

Bearer

AuthorizationBearer <token>

A JSON Web Token

In: header

Path Parameters

userId*string

User id whose payment access should be updated.

Request Body

application/json

Payment access flag.

TypeScript Definitions

Use the request body type in TypeScript.

Payment access update request.

disablePayment?boolean

When true, payment is disabled for this user. When false, payment is enabled.

Response Body

`application/json`

curl -X PUT "https://example.com/users/7f9c2a1e-4b8d-4f6a-9c2e-1d3b5a7e9c01/disable-payment" \  -H "Content-Type: application/json" \  -d '{}'

{  "disablePayment": false,  "email": "string",  "firstName": "string",  "lastName": "string",  "companyName": "string",  "companyNumber": "string",  "companyEmail": "string",  "phone": "string",  "phoneCode": "string",  "address": {    "street": "string",    "city": "string",    "country": "string",    "phone": "string",    "zip": "string"  },  "companyPayment": false,  "note": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Users

200

400application/json

401

200

400application/json

401

200application/json

401

201application/json

401

200application/json

401

200

401

404application/json

200application/json

401

200application/json

401

200application/json

401

200application/json

400application/json

401

200application/json

400application/json

401

200application/json

401

200

401

404application/json

200

401

404

200application/json

400application/json

401

200

400application/json

401

200

400application/json

401

200

400application/json

401

200

400application/json

401

422application/json

200

400application/json

401

200

400application/json

401

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`