API guide
Celoxis API v2
Use the REST API to retrieve, create, update and delete Celoxis data and perform supported entity actions.
Base URL
All endpoints are relative to your Celoxis installation:
https://<your-celoxis-host>/psa/api/v2The examples use https://app.celoxis.com/psa/api/v2.
Supported entities
An entity is a type of Celoxis record, such as a project. Entities also have associations with other entities. For example, a task is associated with its project and with another task that is its parent.
Use the entity key in API URLs. In the paths below, replace {entity} with a key from this table.
| Name | Entity key | Associations |
|---|---|---|
| Projects | projects | manager, clients |
| Tasks | tasks | project, parent, predecessors, assignments |
| Task Updates | taskUpdates | — |
| App Updates | appUpdates | — |
| Time Entries | timeEntries | user, workItem |
| Workflow App Records | apps | — |
| Users | users | — |
| Expenses | expenses | — |
Properties
This guide documents the stable API contract: URLs, methods, request behaviour, responses and examples.