Scopes
A scope gives an API key permission to call a group of endpoints. You choose the scopes when you create an API key. In the Crewsum app, each scope shows its name, its description, and its scope value.
How scopes work
Section titled “How scopes work”- Each endpoint requires exactly one scope. The endpoint page shows it under Required Scope.
- Scopes are matched exactly. There are no parent or wildcard scopes.
- A
writescope does not include the matchingreadscope. To read and change a resource, give the key both scopes. - You cannot change the scopes of an existing key. To change them, generate a new key and delete the old one.
If a key does not have the required scope, the request fails with the message Insufficient scopes, this endpoint requires the following scopes: <scope>. See Errors.
Scope list
Section titled “Scope list”| Scope | Name in the app | Description | Endpoints |
|---|---|---|---|
clients:read | Clients (Read) | View client records and client-related information. | List and get clients |
clients:write | Clients (Write) | Create and update client records. | Create, update, and delete clients |
contacts:read | Contacts (Read) | View contact information and contact history. | List and get contacts |
contacts:write | Contacts (Write) | Create and edit contact records. | Create, update, and delete contacts |
projects:read | Projects (Read) | View project details and project-related information. | List and get projects |
projects:write | Projects (Write) | Create and update projects. | Create, update, and delete projects |
end-customers:read | End Customers (Read) | View end customer records and related client information. | List and get end customers |
end-customers:write | End Customers (Write) | Create and update end customer records. | Create, update, and delete end customers |
tasks:read | Tasks (Read) | View task details and progress. | List and get tasks |
tasks:write | Tasks (Write) | Create, modify, and close tasks. | Create, update, and delete tasks |
associations:read | Associations (Read) | View entity associations and linked records. | List and get associations |
associations:write | Associations (Write) | Create and update entity associations. | Create, update, and delete associations |
users:read | Users (Read) | View user records and profile details. | List and get users |
users:write | Users (Write) | Create and update user accounts. | Create, update, and delete users |
user-groups:read | User Groups (Read) | View user groups and their memberships. | List and get user groups |
user-groups:write | User Groups (Write) | Create and update user groups and memberships. | Create, update, and delete user groups, and set members |
user-assignments:read | User Assignments (Read) | View existing user assignments. | List and get user assignments |
user-assignments:write | User Assignments (Write) | Create and update user assignments. | Create, update, and delete user assignments |
suppliers:read | Suppliers (Read) | View supplier records and information. | List and get suppliers |
suppliers:write | Suppliers (Write) | Create and update supplier records. | Create, update, and delete suppliers |
supplier-contacts:read | Supplier Contacts (Read) | View supplier contacts and related contact details. | List and get supplier contacts |
supplier-contacts:write | Supplier Contacts (Write) | Create and update supplier contacts. | Create, update, and delete supplier contacts |
reports:run | Reports | Generate and run operational reports. | Run report (not yet available) |
timesheets:read | Timesheets (Read) | View submitted and draft timesheets. | List timesheets, Get timesheet |
timesheets:submit-self | Timesheets (Submit) | Submit personal timesheets and log time entries. | Submit own timesheet |
timesheets:submit-admin | Timesheets (Admin Submit) | Submit timesheets on behalf of team members. | Submit timesheet for a user |
timesheets:review | Timesheets (Review) | Review and approve submitted timesheets. | Review timesheet |