API Reference
The Crewsum customer API lets your systems read and change data in your Crewsum account. This reference has one section for each resource, and one page for each endpoint.
New to the API? Start with Get Started.
Basics
Section titled “Basics”| Item | Value |
|---|---|
| Base URL | https://api.crewsum.com. Every endpoint path starts with /v1. |
| Authentication | Send your API key in the x-api-key header. See Authentication. |
| Request bodies | JSON, with Content-Type: application/json. |
| Paging and sorting | See Pagination and sorting. |
| Errors and rate limits | See Errors and rate limits. |
curl "https://api.crewsum.com/v1/clients/clients" \ -H "x-api-key: $CREWSUM_API_KEY"Scopes
Section titled “Scopes”Each endpoint requires one scope, which its page shows. Scopes are matched exactly: an API key must have the exact scope that the endpoint lists. There are no parent or wildcard scopes, and a write scope does not include the matching read scope.
See Scopes for the full list.
Resources
Section titled “Resources” Clients List, get, create, update, and delete clients.
End Customers List, get, create, update, and delete end customers.
Projects List, get, create, update, and delete projects.
Contacts List, get, create, update, and delete contacts.
Tasks List, get, create, update, and delete tasks.
Associations Link contacts to projects.
Suppliers List, get, create, update, and delete suppliers.
Supplier Contacts List, get, create, update, and delete supplier contacts.
Users List, get, create, update, and delete users.
User Groups Organize users into named groups and set group members.
User Assignments Read and manage the projects and tasks assigned to users.
Timesheets List, get, submit, and review timesheets.
Reports Not yet available.