Endpoints for managing clients and users. Both clients and users support metadata which can be used to store arbitrary key-value pairs. Note that when updating a client or user, metadata will replace the existing metadata and not be merged with it.
Do not use personal data such as names or email addresses as customer identifiers (clientIdentifier); the identifier is kept after deletion.
Get clients Build and above
Use this endpoint to get a paginated list of client identifiers.
GET/v1/headless/clients
Query parameters
Field
Type
Required
Default
Description
Options
length
number
No
100
—
page
number
No
0
—
Get client Build and above
Use this endpoint to get a client by identifier.
GET/v1/headless/client/{identifier}
Path parameters
Field
Description
Options
identifier
Your stable client identifier. Do not use personal data such as names or email addresses: this identifier is kept after deletion.
—
Get users Build and above
Use this endpoint to get a paginated list of users. You can optionally filter by clientIdentifier.
GET/v1/headless/users
Query parameters
Field
Type
Required
Default
Description
Options
length
number
No
100
—
page
number
No
0
—
clientIdentifier
string
No
—
—
Get user Build and above
Use this endpoint to get a user by identifier.
GET/v1/headless/user/{identifier}
Path parameters
Field
Description
Options
identifier
Your stable user identifier
—
Update client Build and above
Use this endpoint to update a client's metadata.
PUT/v1/headless/client/{identifier}
Path parameters
Field
Description
Options
identifier
Your stable client identifier. Do not use personal data such as names or email addresses: this identifier is kept after deletion.
—
Body parameters
Field
Type
Required
Desc
Options
metadata
object
No
Arbitrary metadata to attach to the client
—
Delete client Build and above
Use this endpoint to delete all objects associated with a clientIdentifier.
DELETE/v1/headless/client/{identifier}
Path parameters
Field
Description
Options
identifier
Your stable client identifier. Do not use personal data such as names or email addresses: this identifier is kept after deletion.
—
Update user Build and above
Use this endpoint to update a user's metadata. Sending metadata replaces the stored metadata; the user's name and avatar are kept unless you set them. Sending only name or avatar leaves the rest of the metadata unchanged.
PUT/v1/headless/user/{identifier}
Path parameters
Field
Description
Options
identifier
Your stable user identifier
—
Body parameters
Field
Type
Required
Desc
Options
clientIdentifier
string
No
The client this user belongs to
—
metadata
object
No
Arbitrary metadata for the user. Replaces the existing metadata; the stored name and avatar are kept unless set here or by name/avatar.
—
name
string
No
Display name (shorthand for metadata.name)
—
avatar
string
No
Avatar URL (shorthand for metadata.avatar)
—
Delete user Build and above
Use this endpoint to delete a user by their identifier. You can choose what to do with any courses associated with this identifier.