Entity

Users

Retrieve and manage users, clone users and archive users.

Endpoints

GET/api/v2/usersRetrieve a list

GET/api/v2/users/{id}Retrieve one record

POST/api/v2/usersCreate records

PATCH/api/v2/usersUpdate records

Clone a user

POST/api/v2/users/{id}/cloneCreate a user from an existing user

Send a JSON object in the request body with only the properties that should differ from the source user. The response is { data: {created-object} }.

Archive users

POST/api/v2/users/delete/{id1},{id2},…Archive up to 50 users

The response is { success: true, archived: [id1, id2, …], skipped: [] }.

Archives one or more users. Only administrators can call this endpoint. Active users are archived; already archived users are skipped. This is a soft delete — users are not permanently deleted and appear in the People Bin. Up to 50 user IDs can be passed as a comma-separated list.

An optional replacement user can be provided via p_to_uid. The replacement must be an active user in the same company. A user cannot archive themselves or be selected as their own replacement.

To archive users 1, 2 and 3 and reassign their work to user 6:

bash

Example

curl -X POST \
  -H 'Authorization: bearer YourTokenHere' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data 'p_to_uid=6' \
  'https://app.celoxis.com/psa/api/v2/users/delete/1,2,3'

To archive a user without specifying a replacement:

bash

Example

curl -X POST \
  -H 'Authorization: bearer YourTokenHere' \
  'https://app.celoxis.com/psa/api/v2/users/delete/1'