Client

Get clients

GET /api/v1/headless/clients

Use this endpoint to get a paginated list of client identifiers.

Field	Type	Description	Required	Default	Options
`length`	`integer`	Number of results to return	No	`"100"`	N/A
`page`	`integer`	Page number	No	`"0"`	N/A

Code	Description
200	A list of client identifiers

GET /api/v1/headless/users

Use this endpoint to get a paginated list of users. You can optionally filter by clientIdentifier.

Field	Type	Description	Required	Default	Options
`length`	`integer`	Number of results to return	No	`"100"`	N/A
`page`	`integer`	Page number	No	`"0"`	N/A
`clientIdentifier`	`string`	Filter users by clientIdentifier	No	N/A	N/A

Code	Description
200	A list of users

DELETE /api/v1/headless/client/{identifier}

Use this endpoint to delete all objects associated with a clientIdentifier.

Field	Description	Options
`identifier`	Client identifier	N/A

Code	Description
200	All related objects and creators deleted

DELETE /api/v1/headless/user/{identifier}

Use this endpoint to delete a user by their identifier. You can choose what to do with any courses associated with this identifier.

Field	Description	Options
`identifier`	Identifier	N/A

Field	Type	Description	Required	Default	Options
`action`	`string`	How to handle courses allocated to this user	Yes	N/A	`reallocate` `delete` `ignore`
`reallocateTo`	`string`	If action is reallocate, the identifier to reallocate to	No	N/A	N/A

Code	Description
200	Success