{"items":[{"type":"separator","label":"Overview","icon":"home"},{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/","routeSlug":"/","icon":"play"},{"type":"link","fsPath":"authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/authentication","routeSlug":"/authentication","icon":"key"},{"type":"link","fsPath":"scopes.md","metadata":{"type":"markdown"},"label":"Scopes & Permissions","link":"/scopes","routeSlug":"/scopes","icon":"fence"},{"type":"link","fsPath":"filtering.md","metadata":{"type":"markdown"},"label":"Filtering","link":"/filtering","routeSlug":"/filtering","icon":"filters"},{"type":"link","fsPath":"computed-fields.md","metadata":{"type":"markdown"},"label":"Computed fields","link":"/computed-fields","routeSlug":"/computed-fields","icon":"calculator-simple"},{"type":"link","fsPath":"webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/webhooks","separatorLine":true,"routeSlug":"/webhooks","icon":"rss"},{"type":"separator","label":"API references","icon":"rocket"},{"type":"link","label":"Kanbert","link":"/api","routeSlug":"/api"},{"type":"group","label":"Users","link":"/api/users","routeSlug":"/api/users","items":[{"label":"Retrieve current user's information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/users.whoami","routeSlug":"/api/users/users.whoami","metadata":{"seo":{"title":"Retrieve current user's information","description":"No specific scope required."}},"httpPath":"/whoami"},{"label":"List all users (basic)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/users.index","routeSlug":"/api/users/users.index","metadata":{"seo":{"title":"List all users (basic)","description":"No specific scope required."}},"httpPath":"/users"},{"label":"Get all users (full)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/users.fullindex","routeSlug":"/api/users/users.fullindex","metadata":{"seo":{"title":"Get all users (full)","description":"Required scopes: user:read"}},"httpPath":"/users/full"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/users.show","routeSlug":"/api/users/users.show","metadata":{"seo":{"title":"Retrieve a user","description":"No specific scope required."}},"httpPath":"/users/{id}"}]},{"type":"group","label":"Clients","link":"/api/clients","routeSlug":"/api/clients","items":[{"label":"List all clients (basic)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.index","routeSlug":"/api/clients/clients.index","metadata":{"seo":{"title":"List all clients (basic)","description":"No specific scope required."}},"httpPath":"/clients"},{"label":"Create a client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.store","routeSlug":"/api/clients/clients.store","metadata":{"seo":{"title":"Create a client","description":"Required scopes: client:write"}},"httpPath":"/clients"},{"label":"List all clients (full)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.fullindex","routeSlug":"/api/clients/clients.fullindex","metadata":{"seo":{"title":"List all clients (full)","description":"Required scopes: client:read"}},"httpPath":"/clients/full"},{"label":"Retrieve a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.show","routeSlug":"/api/clients/clients.show","metadata":{"seo":{"title":"Retrieve a client","description":"No specific scope required."}},"httpPath":"/clients/{id}"},{"label":"Update a client","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.update","routeSlug":"/api/clients/clients.update","metadata":{"seo":{"title":"Update a client","description":"Required scopes: client:write"}},"httpPath":"/clients/{id}"},{"label":"Archive a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.destroy","routeSlug":"/api/clients/clients.destroy","metadata":{"seo":{"title":"Archive a client","description":"Required scopes: client:write"}},"httpPath":"/clients/{id}"},{"label":"Update a client's external identifier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.updateexternalid","routeSlug":"/api/clients/clients.updateexternalid","metadata":{"seo":{"title":"Update a client's external identifier","description":"Required scopes: client:write"}},"httpPath":"/clients/{id}/external-identifier"},{"label":"Update a client's shortcode","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.updateshortcode","routeSlug":"/api/clients/clients.updateshortcode","metadata":{"seo":{"title":"Update a client's shortcode","description":"Required scopes: client:write"}},"httpPath":"/clients/{id}/shortcode"},{"label":"Restore a client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/clients/clients.restore","routeSlug":"/api/clients/clients.restore","metadata":{"seo":{"title":"Restore a client","description":"Required scopes: client:write"}},"httpPath":"/clients/{id}/restore"}]},{"type":"group","label":"Projects","link":"/api/projects","routeSlug":"/api/projects","items":[{"label":"List all projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.index","routeSlug":"/api/projects/projects.index","metadata":{"seo":{"title":"List all projects","description":"No specific scope required."}},"httpPath":"/projects"},{"label":"Create a project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.store","routeSlug":"/api/projects/projects.store","metadata":{"seo":{"title":"Create a project","description":"Required scopes: project:write"}},"httpPath":"/projects"},{"label":"Update a project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.update","routeSlug":"/api/projects/projects.update","metadata":{"seo":{"title":"Update a project","description":"Required scopes: project:write"}},"httpPath":"/projects/{id}"},{"label":"Retrieve a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.show","routeSlug":"/api/projects/projects.show","metadata":{"seo":{"title":"Retrieve a project","description":"No specific scope required."}},"httpPath":"/projects/{id}"},{"label":"List all project team members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.team","routeSlug":"/api/projects/projects.team","metadata":{"seo":{"title":"List all project team members","description":"No specific scope required."}},"httpPath":"/projects/{id}/team"},{"label":"List all project guests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.guests","routeSlug":"/api/projects/projects.guests","metadata":{"seo":{"title":"List all project guests","description":"No specific scope required."}},"httpPath":"/projects/{id}/guests"},{"label":"List all project phases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.phases","routeSlug":"/api/projects/projects.phases","metadata":{"seo":{"title":"List all project phases","description":"Required scopes: task-management:read"}},"httpPath":"/projects/{id}/phases"},{"label":"List all project milestones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.milestones","routeSlug":"/api/projects/projects.milestones","metadata":{"seo":{"title":"List all project milestones","description":"Required scopes: task-management:read"}},"httpPath":"/projects/{id}/milestones"},{"label":"List all project epics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.epics","routeSlug":"/api/projects/projects.epics","metadata":{"seo":{"title":"List all project epics","description":"Required scopes: task-management:read"}},"httpPath":"/projects/{id}/epics"},{"label":"List all project status updates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.statusupdates","routeSlug":"/api/projects/projects.statusupdates","metadata":{"seo":{"title":"List all project status updates","description":"No specific scope required."}},"httpPath":"/projects/{id}/status-updates"},{"label":"List all project tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/projects/projects.tasks","routeSlug":"/api/projects/projects.tasks","metadata":{"seo":{"title":"List all project tasks","description":"Required scopes: task-management:read"}},"httpPath":"/projects/{id}/tasks"}]},{"type":"group","label":"Portfolios & Project Groups","link":"/api/portfolios-and-project-groups","routeSlug":"/api/portfolios-and-project-groups","items":[{"label":"List all portfolios","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios-and-project-groups/projectportfolios.index","routeSlug":"/api/portfolios-and-project-groups/projectportfolios.index","metadata":{"seo":{"title":"List all portfolios","description":"No specific scope required."}},"httpPath":"/portfolios"},{"label":"List all project groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios-and-project-groups/projectportfolios.projectgroups","routeSlug":"/api/portfolios-and-project-groups/projectportfolios.projectgroups","metadata":{"seo":{"title":"List all project groups","description":"No specific scope required."}},"httpPath":"/project-groups"}]},{"type":"group","label":"Tasks","link":"/api/tasks","routeSlug":"/api/tasks","items":[{"label":"List all tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tasks/tasks.index","routeSlug":"/api/tasks/tasks.index","metadata":{"seo":{"title":"List all tasks","description":"Required scopes: task-management:read"}},"httpPath":"/tasks"},{"label":"Create a task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tasks/tasks.store","routeSlug":"/api/tasks/tasks.store","metadata":{"seo":{"title":"Create a task","description":"Required scopes: task-management:write"}},"httpPath":"/tasks"},{"label":"Retrieve a task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tasks/tasks.show","routeSlug":"/api/tasks/tasks.show","metadata":{"seo":{"title":"Retrieve a task","description":"Required scopes: task-management:read"}},"httpPath":"/tasks/{id}"},{"label":"Archive a task","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tasks/tasks.delete","routeSlug":"/api/tasks/tasks.delete","metadata":{"seo":{"title":"Archive a task","description":"Required scopes: task-management:write"}},"httpPath":"/tasks/{id}"},{"label":"Update a task","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tasks/tasks.update","routeSlug":"/api/tasks/tasks.update","metadata":{"seo":{"title":"Update a task","description":"Required scopes: task-management:write"}},"httpPath":"/tasks/{task}"},{"label":"Update a tasks's external identifier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tasks/tasks.updateexternalid","routeSlug":"/api/tasks/tasks.updateexternalid","metadata":{"seo":{"title":"Update a tasks's external identifier","description":"Required scopes: client:write"}},"httpPath":"/tasks/{id}/external-identifier"},{"label":"Upload file to a task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tasks/tasks.upload","routeSlug":"/api/tasks/tasks.upload","metadata":{"seo":{"title":"Upload file to a task","description":"Required scopes: task-management:write"}},"httpPath":"/tasks/{id}/upload"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Task created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tasks/paths/task:created/post","routeSlug":"/api/tasks/paths/task:created/post","metadata":{"seo":{"title":"Task created","description":"task:create - A new task was created"}},"httpPath":"task:created"},{"label":"Task updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tasks/paths/task:updated/post","routeSlug":"/api/tasks/paths/task:updated/post","metadata":{"seo":{"title":"Task updated","description":"task:update A Task was updated"}},"httpPath":"task:updated"},{"label":"Task deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tasks/paths/task:deleted/post","routeSlug":"/api/tasks/paths/task:deleted/post","metadata":{"seo":{"title":"Task deleted","description":"task:delete - A task was deleted"}},"httpPath":"task:deleted"}]},{"type":"group","label":"Work Time","link":"/api/work-time","routeSlug":"/api/work-time","items":[{"label":"List work time days","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/work-time/worktime.index","routeSlug":"/api/work-time/worktime.index","metadata":{"seo":{"title":"List work time days","description":"Required scopes: work-time:read"}},"httpPath":"/work-time"},{"label":"Retrieve a work time day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/work-time/worktime.show","routeSlug":"/api/work-time/worktime.show","metadata":{"seo":{"title":"Retrieve a work time day","description":"Required scopes: work-time:read"}},"httpPath":"/work-time/{userId}/{date}"},{"label":"Update a work time day","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/work-time/worktime.update","routeSlug":"/api/work-time/worktime.update","metadata":{"seo":{"title":"Update a work time day","description":"Required scopes: work-time:write"}},"httpPath":"/work-time/{userId}/{date}"},{"label":"List computed overtime hours","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/work-time/overtimehours.index","routeSlug":"/api/work-time/overtimehours.index","metadata":{"seo":{"title":"List computed overtime hours","description":"Required scopes: work-time:read"}},"httpPath":"/overtime-hours"},{"label":"List flexible hours","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/work-time/flexiblehours.index","routeSlug":"/api/work-time/flexiblehours.index","metadata":{"seo":{"title":"List flexible hours","description":"Required scopes: work-time:read"}},"httpPath":"/flexible-hours"},{"label":"List absences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/work-time/absences.index","routeSlug":"/api/work-time/absences.index","metadata":{"seo":{"title":"List absences","description":"Required scopes: work-time:read"}},"httpPath":"/absences"}]},{"type":"group","label":"Task Comments","link":"/api/task-comments","routeSlug":"/api/task-comments","items":[{"label":"Create a new comment for a task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/task-comments/taskcomments.store","routeSlug":"/api/task-comments/taskcomments.store","metadata":{"seo":{"title":"Create a new comment for a task","description":"Required scopes: task-management:write"}},"httpPath":"/tasks/comments"},{"label":"Update a tasks comment's content","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/task-comments/taskcomments.update","routeSlug":"/api/task-comments/taskcomments.update","metadata":{"seo":{"title":"Update a tasks comment's content","description":"Required scopes: task-management:write"}},"httpPath":"/tasks/comments/{id}"},{"label":"Retrieve a tasks comment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/task-comments/taskcomments.show","routeSlug":"/api/task-comments/taskcomments.show","metadata":{"seo":{"title":"Retrieve a tasks comment","description":"Required scopes: task-management:read"}},"httpPath":"/tasks/comments/{id}"},{"label":"Delete a tasks comment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/task-comments/taskcomments.destroy","routeSlug":"/api/task-comments/taskcomments.destroy","metadata":{"seo":{"title":"Delete a tasks comment","description":"Required scopes: task-management:write"}},"httpPath":"/tasks/comments/{id}"},{"label":"Upload file to a task comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/task-comments/taskcomments.upload","routeSlug":"/api/task-comments/taskcomments.upload","metadata":{"seo":{"title":"Upload file to a task comment","description":"Required scopes: task-management:write"}},"httpPath":"/tasks/comments/{id}/upload"},{"label":"List all comments for a task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/task-comments/taskcomments.comments","routeSlug":"/api/task-comments/taskcomments.comments","metadata":{"seo":{"title":"List all comments for a task","description":"Required scopes: task-management:read"}},"httpPath":"/tasks/{id}/comments"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Comment created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/task-comments/paths/comment:created/post","routeSlug":"/api/task-comments/paths/comment:created/post","metadata":{"seo":{"title":"Comment created","description":"comment:create - A new comment was created"}},"httpPath":"comment:created"},{"label":"Comment updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/task-comments/paths/comment:updated/post","routeSlug":"/api/task-comments/paths/comment:updated/post","metadata":{"seo":{"title":"Comment updated","description":"comment:update A Comment was updated"}},"httpPath":"comment:updated"},{"label":"Comment deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/task-comments/paths/comment:deleted/post","routeSlug":"/api/task-comments/paths/comment:deleted/post","metadata":{"seo":{"title":"Comment deleted","description":"comment:delete - A comment was deleted"}},"httpPath":"comment:deleted"}]},{"type":"group","label":"Work Time Periods","link":"/api/work-time-periods","routeSlug":"/api/work-time-periods","items":[{"label":"List work time periods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/work-time-periods/worktimeperiods.index","routeSlug":"/api/work-time-periods/worktimeperiods.index","metadata":{"seo":{"title":"List work time periods","description":"Required scopes: work-time-periods:read"}},"httpPath":"/work-time-periods"}]},{"type":"group","label":"Efforts","link":"/api/efforts","routeSlug":"/api/efforts","items":[{"label":"List all efforts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/efforts/efforts.index","routeSlug":"/api/efforts/efforts.index","metadata":{"seo":{"title":"List all efforts","description":"Required scopes: efforts:read"}},"httpPath":"/efforts"}]},{"type":"group","label":"Contacts","link":"/api/contacts","routeSlug":"/api/contacts","items":[{"label":"List all contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.index","routeSlug":"/api/contacts/contacts.index","metadata":{"seo":{"title":"List all contacts","description":"Required scopes: contact-data:read"}},"httpPath":"/contacts"},{"label":"Create a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.store","routeSlug":"/api/contacts/contacts.store","metadata":{"seo":{"title":"Create a contact","description":"Required scopes: contact-data:write"}},"httpPath":"/contacts"},{"label":"Retrieve a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.show","routeSlug":"/api/contacts/contacts.show","metadata":{"seo":{"title":"Retrieve a contact","description":"Required scopes: contact-data:read"}},"httpPath":"/contacts/{id}"},{"label":"Update a contact","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.update","routeSlug":"/api/contacts/contacts.update","metadata":{"seo":{"title":"Update a contact","description":"Required scopes: contact-data:write"}},"httpPath":"/contacts/{id}"},{"label":"Archive a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.destroy","routeSlug":"/api/contacts/contacts.destroy","metadata":{"seo":{"title":"Archive a contact","description":"Required scopes: contact-data:write"}},"httpPath":"/contacts/{id}"},{"label":"Update a contacts external identifier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.updateexternalid","routeSlug":"/api/contacts/contacts.updateexternalid","metadata":{"seo":{"title":"Update a contacts external identifier","description":"Required scopes: contact-data:write"}},"httpPath":"/contacts/{id}/external-identifier"},{"label":"Attach a contact to a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.associatecompany","routeSlug":"/api/contacts/contacts.associatecompany","metadata":{"seo":{"title":"Attach a contact to a company","description":"Required scopes: contact-data:write"}},"httpPath":"/contacts/{id}/company/attach"},{"label":"Detach a contact from a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.unassociatecompany","routeSlug":"/api/contacts/contacts.unassociatecompany","metadata":{"seo":{"title":"Detach a contact from a company","description":"Required scopes: contact-data:write"}},"httpPath":"/contacts/{id}/company/detach"},{"label":"Restore a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/contacts/contacts.restore","routeSlug":"/api/contacts/contacts.restore","metadata":{"seo":{"title":"Restore a contact","description":"Required scopes: contact-data:write"}},"httpPath":"/contacts/{id}/restore"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Contact created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/contacts/paths/contact:created/post","routeSlug":"/api/contacts/paths/contact:created/post","metadata":{"seo":{"title":"Contact created","description":"contact:create - Fired when a new contact was created"}},"httpPath":"contact:created"},{"label":"Contact updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/contacts/paths/contact:update/post","routeSlug":"/api/contacts/paths/contact:update/post","metadata":{"seo":{"title":"Contact updated","description":"contact:update - Fired when a contact was updated"}},"httpPath":"contact:update"},{"label":"Contact deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/contacts/paths/contact:deleted/post","routeSlug":"/api/contacts/paths/contact:deleted/post","metadata":{"seo":{"title":"Contact deleted","description":"contact:delete - A contact was deleted"}},"httpPath":"contact:deleted"}]},{"type":"group","label":"Companies","link":"/api/companies","routeSlug":"/api/companies","items":[{"label":"List all companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/companies/companies.index","routeSlug":"/api/companies/companies.index","metadata":{"seo":{"title":"List all companies","description":"Required scopes: contact-data:read"}},"httpPath":"/companies"},{"label":"Create a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/companies/companies.store","routeSlug":"/api/companies/companies.store","metadata":{"seo":{"title":"Create a company","description":"Required scopes: contact-data:write"}},"httpPath":"/companies"},{"label":"Retrieve a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/companies/companies.show","routeSlug":"/api/companies/companies.show","metadata":{"seo":{"title":"Retrieve a company","description":"Required scopes: contact-data:read"}},"httpPath":"/companies/{id}"},{"label":"Update a company","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/companies/companies.update","routeSlug":"/api/companies/companies.update","metadata":{"seo":{"title":"Update a company","description":"Required scopes: contact-data:write"}},"httpPath":"/companies/{id}"},{"label":"Archive a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/companies/companies.destroy","routeSlug":"/api/companies/companies.destroy","metadata":{"seo":{"title":"Archive a company","description":"Required scopes: contact-data:write"}},"httpPath":"/companies/{id}"},{"label":"Update a companys external identifier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/companies/companies.updateexternalid","routeSlug":"/api/companies/companies.updateexternalid","metadata":{"seo":{"title":"Update a companys external identifier","description":"Required scopes: contact-data:write"}},"httpPath":"/companies/{id}/external-identifier"},{"label":"Restore a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/companies/companies.restore","routeSlug":"/api/companies/companies.restore","metadata":{"seo":{"title":"Restore a company","description":"Required scopes: contact-data:write"}},"httpPath":"/companies/{id}/restore"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Company created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/companies/paths/company:created/post","routeSlug":"/api/companies/paths/company:created/post","metadata":{"seo":{"title":"Company created","description":"company:create - A new company was created"}},"httpPath":"company:created"},{"label":"Company updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/companies/paths/company:updated/post","routeSlug":"/api/companies/paths/company:updated/post","metadata":{"seo":{"title":"Company updated","description":"company:update A company was updated"}},"httpPath":"company:updated"},{"label":"Company deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/companies/paths/company:deleted/post","routeSlug":"/api/companies/paths/company:deleted/post","metadata":{"seo":{"title":"Company deleted","description":"company:delete - A company was deleted"}},"httpPath":"company:deleted"}]},{"type":"group","label":"Offers","link":"/api/offers","routeSlug":"/api/offers","items":[{"label":"List all offers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/offers/offers.index","routeSlug":"/api/offers/offers.index","metadata":{"seo":{"title":"List all offers","description":"Required scopes: offer:read"}},"httpPath":"/offers"},{"label":"Retrieve an offer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/offers/offers.show","routeSlug":"/api/offers/offers.show","metadata":{"seo":{"title":"Retrieve an offer","description":"Required scopes: offer:read"}},"httpPath":"/offers/{id}"},{"label":"List all offer lineItems","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/offers/offers.lineitems","routeSlug":"/api/offers/offers.lineitems","metadata":{"seo":{"title":"List all offer lineItems","description":"Required scopes: offer:read"}},"httpPath":"/offers/{id}/line-items"},{"label":"Download offer PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/offers/offers.pdf","routeSlug":"/api/offers/offers.pdf","metadata":{"seo":{"title":"Download offer PDF","description":"Required scopes: offer:read"}},"httpPath":"/offers/{id}/pdf"}]},{"type":"group","label":"Outgoing Invoices","link":"/api/outgoing-invoices","routeSlug":"/api/outgoing-invoices","items":[{"label":"List all invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.index","routeSlug":"/api/outgoing-invoices/outgoinginvoices.index","metadata":{"seo":{"title":"List all invoices","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/outgoing-invoices"},{"label":"Create an outgoing invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.store","routeSlug":"/api/outgoing-invoices/outgoinginvoices.store","metadata":{"seo":{"title":"Create an outgoing invoice","description":"Required scopes: outgoing-invoice:write"}},"httpPath":"/outgoing-invoices"},{"label":"List all invoice master plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.masterplans","routeSlug":"/api/outgoing-invoices/outgoinginvoices.masterplans","metadata":{"seo":{"title":"List all invoice master plans","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/outgoing-invoices/master"},{"label":"Retrieve an invoice master plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.showmaster","routeSlug":"/api/outgoing-invoices/outgoinginvoices.showmaster","metadata":{"seo":{"title":"Retrieve an invoice master plan","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/outgoing-invoices/master/{id}"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.show","routeSlug":"/api/outgoing-invoices/outgoinginvoices.show","metadata":{"seo":{"title":"Retrieve an invoice","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/outgoing-invoices/{id}"},{"label":"Update an outgoing invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.update","routeSlug":"/api/outgoing-invoices/outgoinginvoices.update","metadata":{"seo":{"title":"Update an outgoing invoice","description":"Required scopes: outgoing-invoice:write"}},"httpPath":"/outgoing-invoices/{id}"},{"label":"Delete an outgoing invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.destroy","routeSlug":"/api/outgoing-invoices/outgoinginvoices.destroy","metadata":{"seo":{"title":"Delete an outgoing invoice","description":"Required scopes: outgoing-invoice:write"}},"httpPath":"/outgoing-invoices/{id}"},{"label":"List all invoice lineItems","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.lineitems","routeSlug":"/api/outgoing-invoices/outgoinginvoices.lineitems","metadata":{"seo":{"title":"List all invoice lineItems","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/outgoing-invoices/{id}/line-items"},{"label":"Upload a manual invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.createexternal","routeSlug":"/api/outgoing-invoices/outgoinginvoices.createexternal","metadata":{"seo":{"title":"Upload a manual invoice","description":"Required scopes: outgoing-invoice:upload"}},"httpPath":"/outgoing-invoices/external"},{"label":"Create a recurring invoice plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.storerecurringplan","routeSlug":"/api/outgoing-invoices/outgoinginvoices.storerecurringplan","metadata":{"seo":{"title":"Create a recurring invoice plan","description":"Required scopes: outgoing-invoice:write"}},"httpPath":"/outgoing-invoices/recurring-plans"},{"label":"Create a partial-invoice plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.storepartialplan","routeSlug":"/api/outgoing-invoices/outgoinginvoices.storepartialplan","metadata":{"seo":{"title":"Create a partial-invoice plan","description":"Required scopes: outgoing-invoice:write"}},"httpPath":"/outgoing-invoices/partial-plans"},{"label":"Add a plan invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.storeplaninvoice","routeSlug":"/api/outgoing-invoices/outgoinginvoices.storeplaninvoice","metadata":{"seo":{"title":"Add a plan invoice","description":"Required scopes: outgoing-invoice:write"}},"httpPath":"/outgoing-invoices/{id}/plan-invoices"},{"label":"Generate plan invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.generate","routeSlug":"/api/outgoing-invoices/outgoinginvoices.generate","metadata":{"seo":{"title":"Generate plan invoices","description":"Required scopes: outgoing-invoice:write"}},"httpPath":"/outgoing-invoices/{id}/generate"},{"label":"Book an outgoing invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.book","routeSlug":"/api/outgoing-invoices/outgoinginvoices.book","metadata":{"seo":{"title":"Book an outgoing invoice","description":"Required scopes: outgoing-invoice:book"}},"httpPath":"/outgoing-invoices/{id}/book"},{"label":"Force-delete an outgoing invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.forcedestroy","routeSlug":"/api/outgoing-invoices/outgoinginvoices.forcedestroy","metadata":{"seo":{"title":"Force-delete an outgoing invoice","description":"Required scopes: outgoing-invoice:force-delete"}},"httpPath":"/outgoing-invoices/{id}/force"},{"label":"Download invoice PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/outgoing-invoices/outgoinginvoices.pdf","routeSlug":"/api/outgoing-invoices/outgoinginvoices.pdf","metadata":{"seo":{"title":"Download invoice PDF","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/outgoing-invoices/{id}/pdf"}]},{"type":"group","label":"Incoming Invoices","link":"/api/incoming-invoices","routeSlug":"/api/incoming-invoices","items":[{"label":"List all incoming invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/incoming-invoices/incominginvoices.index","routeSlug":"/api/incoming-invoices/incominginvoices.index","metadata":{"seo":{"title":"List all incoming invoices","description":"Required scopes: incoming-invoice:read"}},"httpPath":"/incoming-invoices"},{"label":"Upload an incoming invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/incoming-invoices/incominginvoices.store","routeSlug":"/api/incoming-invoices/incominginvoices.store","metadata":{"seo":{"title":"Upload an incoming invoice","description":"Required scopes: incoming-invoice:write"}},"httpPath":"/incoming-invoices"},{"label":"Retrieve an incoming invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/incoming-invoices/incominginvoices.show","routeSlug":"/api/incoming-invoices/incominginvoices.show","metadata":{"seo":{"title":"Retrieve an incoming invoice","description":"Required scopes: incoming-invoice:read"}},"httpPath":"/incoming-invoices/{id}"},{"label":"Update an incoming invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/incoming-invoices/incominginvoices.update","routeSlug":"/api/incoming-invoices/incominginvoices.update","metadata":{"seo":{"title":"Update an incoming invoice","description":"Required scopes: incoming-invoice:write"}},"httpPath":"/incoming-invoices/{id}"},{"label":"Check for duplicate uploads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/incoming-invoices/incominginvoices.checkhash","routeSlug":"/api/incoming-invoices/incominginvoices.checkhash","metadata":{"seo":{"title":"Check for duplicate uploads","description":"Required scopes: incoming-invoice:read"}},"httpPath":"/incoming-invoices/check-duplicate"},{"label":"Update a booking","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/incoming-invoices/incominginvoices.updatebooking","routeSlug":"/api/incoming-invoices/incominginvoices.updatebooking","metadata":{"seo":{"title":"Update a booking","description":"Required scopes: incoming-invoice:write, chart-of-accounts:write"}},"httpPath":"/incoming-invoices/{invoiceId}/bookings/{bookingId}"},{"label":"Delete a booking","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/incoming-invoices/incominginvoices.destroybooking","routeSlug":"/api/incoming-invoices/incominginvoices.destroybooking","metadata":{"seo":{"title":"Delete a booking","description":"Required scopes: incoming-invoice:write, chart-of-accounts:write"}},"httpPath":"/incoming-invoices/{invoiceId}/bookings/{bookingId}"}]},{"type":"group","label":"Chart of Accounts","link":"/api/chart-of-accounts","routeSlug":"/api/chart-of-accounts","items":[{"label":"List all chart of accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/chart-of-accounts/chartofaccounts.index","routeSlug":"/api/chart-of-accounts/chartofaccounts.index","metadata":{"seo":{"title":"List all chart of accounts","description":"Required scopes: chart-of-accounts:read"}},"httpPath":"/chart-of-accounts"},{"label":"List bookings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/chart-of-accounts/chartofaccounts.bookings","routeSlug":"/api/chart-of-accounts/chartofaccounts.bookings","metadata":{"seo":{"title":"List bookings","description":"Required scopes: chart-of-accounts:read"}},"httpPath":"/chart-of-accounts/bookings"},{"label":"Retrieve a single chart of account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/chart-of-accounts/chartofaccounts.show","routeSlug":"/api/chart-of-accounts/chartofaccounts.show","metadata":{"seo":{"title":"Retrieve a single chart of account","description":"Required scopes: chart-of-accounts:read"}},"httpPath":"/chart-of-accounts/{id}"}]},{"type":"group","label":"Payments","link":"/api/payments","routeSlug":"/api/payments","items":[{"label":"List all payment accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payments/payments.accounts","routeSlug":"/api/payments/payments.accounts","metadata":{"seo":{"title":"List all payment accounts","description":"Required scopes: payments:read"}},"httpPath":"/payment-accounts"},{"label":"List all payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payments/payments.payments","routeSlug":"/api/payments/payments.payments","metadata":{"seo":{"title":"List all payments","description":"Required scopes: payments:read"}},"httpPath":"/payments"},{"label":"Add payment for an outgoing invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payments/payments.createoutgoinginvoicepayment","routeSlug":"/api/payments/payments.createoutgoinginvoicepayment","metadata":{"seo":{"title":"Add payment for an outgoing invoice","description":"Required scopes: payments:write"}},"httpPath":"/payments/outgoing-invoice"},{"label":"Associate an outgoing invoice with an outgoing credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payments/payments.createoutgoinginvoicereferencebooking","routeSlug":"/api/payments/payments.createoutgoinginvoicereferencebooking","metadata":{"seo":{"title":"Associate an outgoing invoice with an outgoing credit","description":"Required scopes: payments:write"}},"httpPath":"/payments/outgoing-invoice-credit"},{"label":"Add payment for an incoming invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payments/payments.createincominginvoicepayment","routeSlug":"/api/payments/payments.createincominginvoicepayment","metadata":{"seo":{"title":"Add payment for an incoming invoice","description":"Required scopes: payments:write"}},"httpPath":"/payments/incoming-invoice"},{"label":"Associate an incoming invoice with an incoming credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payments/payments.createincominginvoicereferencebooking","routeSlug":"/api/payments/payments.createincominginvoicereferencebooking","metadata":{"seo":{"title":"Associate an incoming invoice with an incoming credit","description":"Required scopes: payments:write"}},"httpPath":"/payments/incoming-invoice-credit"}]},{"type":"group","label":"Usergroups & Teams","link":"/api/usergroups-and-teams","routeSlug":"/api/usergroups-and-teams","items":[{"label":"List all usergroups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/usergroups-and-teams/usergroups.index","routeSlug":"/api/usergroups-and-teams/usergroups.index","metadata":{"seo":{"title":"List all usergroups","description":"Required scopes: user_group:read"}},"httpPath":"/user-group"},{"label":"Retrieve a usergroup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/usergroups-and-teams/usergroups.show","routeSlug":"/api/usergroups-and-teams/usergroups.show","metadata":{"seo":{"title":"Retrieve a usergroup","description":"Required scopes: user_group:read"}},"httpPath":"/user-group/{id}"}]},{"type":"group","label":"Suppliers","link":"/api/suppliers","routeSlug":"/api/suppliers","items":[{"label":"List all suppliers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/suppliers/suppliers.index","routeSlug":"/api/suppliers/suppliers.index","metadata":{"seo":{"title":"List all suppliers","description":"Required scopes: incoming-invoice:read"}},"httpPath":"/suppliers"},{"label":"Create a supplier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/suppliers/suppliers.store","routeSlug":"/api/suppliers/suppliers.store","metadata":{"seo":{"title":"Create a supplier","description":"Required scopes: incoming-invoice:write"}},"httpPath":"/suppliers"},{"label":"Retrieve a supplier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/suppliers/suppliers.show","routeSlug":"/api/suppliers/suppliers.show","metadata":{"seo":{"title":"Retrieve a supplier","description":"Required scopes: incoming-invoice:read"}},"httpPath":"/suppliers/{id}"},{"label":"Update a supplier","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/suppliers/suppliers.update","routeSlug":"/api/suppliers/suppliers.update","metadata":{"seo":{"title":"Update a supplier","description":"Required scopes: incoming-invoice:write"}},"httpPath":"/suppliers/{id}"}]},{"type":"group","label":"Accounting Settings","link":"/api/accounting-settings","routeSlug":"/api/accounting-settings","items":[{"label":"List metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounting-settings/accountingsettings.metrics","routeSlug":"/api/accounting-settings/accountingsettings.metrics","metadata":{"seo":{"title":"List metrics","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/metrics"},{"label":"List PDF templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounting-settings/accountingsettings.pdftemplates","routeSlug":"/api/accounting-settings/accountingsettings.pdftemplates","metadata":{"seo":{"title":"List PDF templates","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/pdf-templates"},{"label":"List accounting enumerations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounting-settings/accountingsettings.enumerations","routeSlug":"/api/accounting-settings/accountingsettings.enumerations","metadata":{"seo":{"title":"List accounting enumerations","description":"Required scopes: outgoing-invoice:read"}},"httpPath":"/accounting-enumerations"}]},{"type":"group","label":"Settings","link":"/api/settings","routeSlug":"/api/settings","items":[{"label":"Retrieve all countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settings/settings.countries","routeSlug":"/api/settings/settings.countries","metadata":{"seo":{"title":"Retrieve all countries","description":"No specific scope required."}},"httpPath":"/settings/countries"},{"label":"Retrieve available currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settings/settings.currencies","routeSlug":"/api/settings/settings.currencies","metadata":{"seo":{"title":"Retrieve available currencies","description":"No specific scope required."}},"httpPath":"/settings/currencies"}]},{"type":"group","label":"Integration","link":"/api/integration","routeSlug":"/api/integration","items":[{"label":"Retrieve current integration's information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/integration/integration.show","routeSlug":"/api/integration/integration.show","metadata":{"seo":{"title":"Retrieve current integration's information","description":"No specific scope required."}},"httpPath":"/integration"}]},{"type":"group","label":"Files","link":"/api/files","routeSlug":"/api/files","items":[{"label":"Retrieve a file's data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/file.show","routeSlug":"/api/files/file.show","metadata":{"seo":{"title":"Retrieve a file's data","description":"No specific scope required."}},"httpPath":"/files/{id}"},{"label":"Download a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/file.download","routeSlug":"/api/files/file.download","metadata":{"seo":{"title":"Download a file","description":"No specific scope required."}},"httpPath":"/files/{id}/download"}]},{"type":"group","label":"Custom Fields","link":"/api/custom-fields","routeSlug":"/api/custom-fields","items":[{"label":"List all custom fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/custom-fields/customfields.index","routeSlug":"/api/custom-fields/customfields.index","metadata":{"seo":{"title":"List all custom fields","description":"Required scopes: integration"}},"httpPath":"/custom-fields"}]},{"type":"group","label":"Webhook Management","link":"/api/webhook-management","routeSlug":"/api/webhook-management","items":[{"label":"List all registered webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-management/webhooks.index","routeSlug":"/api/webhook-management/webhooks.index","metadata":{"seo":{"title":"List all registered webhooks","description":"Required scopes: integration"}},"httpPath":"/webhooks"},{"label":"Register a new webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-management/webhooks.store","routeSlug":"/api/webhook-management/webhooks.store","metadata":{"seo":{"title":"Register a new webhook","description":"Required scopes: integration"}},"httpPath":"/webhooks"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-management/webhooks.destroy","routeSlug":"/api/webhook-management/webhooks.destroy","metadata":{"seo":{"title":"Delete a webhook","description":"Required scopes: integration"}},"httpPath":"/webhooks/{id}"}]},{"type":"group","label":"Schemas","link":"/api/schemas","routeSlug":"/api/schemas","items":[{"type":"link","label":"AbsenceData","link":"/api/schemas/absencedata","routeSlug":"/api/schemas/absencedata","httpVerb":"schema"},{"type":"link","label":"AccountingEnumerationData","link":"/api/schemas/accountingenumerationdata","routeSlug":"/api/schemas/accountingenumerationdata","httpVerb":"schema"},{"type":"link","label":"AccountingLineItemType","link":"/api/schemas/accountinglineitemtype","routeSlug":"/api/schemas/accountinglineitemtype","httpVerb":"schema"},{"type":"link","label":"BookingType","link":"/api/schemas/bookingtype","routeSlug":"/api/schemas/bookingtype","httpVerb":"schema"},{"type":"link","label":"BusinessFieldData","link":"/api/schemas/businessfielddata","routeSlug":"/api/schemas/businessfielddata","httpVerb":"schema"},{"type":"link","label":"ChartOfAccountData","link":"/api/schemas/chartofaccountdata","routeSlug":"/api/schemas/chartofaccountdata","httpVerb":"schema"},{"type":"link","label":"ChartOfAccountsBookingData","link":"/api/schemas/chartofaccountsbookingdata","routeSlug":"/api/schemas/chartofaccountsbookingdata","httpVerb":"schema"},{"type":"link","label":"ChartOfAccountsBookingDocumentData","link":"/api/schemas/chartofaccountsbookingdocumentdata","routeSlug":"/api/schemas/chartofaccountsbookingdocumentdata","httpVerb":"schema"},{"type":"link","label":"ChartOfAccountType","link":"/api/schemas/chartofaccounttype","routeSlug":"/api/schemas/chartofaccounttype","httpVerb":"schema"},{"type":"link","label":"ClientData","link":"/api/schemas/clientdata","routeSlug":"/api/schemas/clientdata","httpVerb":"schema"},{"type":"link","label":"ClientFullData","link":"/api/schemas/clientfulldata","routeSlug":"/api/schemas/clientfulldata","httpVerb":"schema"},{"type":"link","label":"ClientSegment","link":"/api/schemas/clientsegment","routeSlug":"/api/schemas/clientsegment","httpVerb":"schema"},{"type":"link","label":"CommentData","link":"/api/schemas/commentdata","routeSlug":"/api/schemas/commentdata","httpVerb":"schema"},{"type":"link","label":"CompanyData","link":"/api/schemas/companydata","routeSlug":"/api/schemas/companydata","httpVerb":"schema"},{"type":"link","label":"ContactCompanyPivotData","link":"/api/schemas/contactcompanypivotdata","routeSlug":"/api/schemas/contactcompanypivotdata","httpVerb":"schema"},{"type":"link","label":"ContactData","link":"/api/schemas/contactdata","routeSlug":"/api/schemas/contactdata","httpVerb":"schema"},{"type":"link","label":"CountryData","link":"/api/schemas/countrydata","routeSlug":"/api/schemas/countrydata","httpVerb":"schema"},{"type":"link","label":"CurrencyData","link":"/api/schemas/currencydata","routeSlug":"/api/schemas/currencydata","httpVerb":"schema"},{"type":"link","label":"CustomFieldData","link":"/api/schemas/customfielddata","routeSlug":"/api/schemas/customfielddata","httpVerb":"schema"},{"type":"link","label":"CustomFieldEntityType","link":"/api/schemas/customfieldentitytype","routeSlug":"/api/schemas/customfieldentitytype","httpVerb":"schema"},{"type":"link","label":"CustomFieldType","link":"/api/schemas/customfieldtype","routeSlug":"/api/schemas/customfieldtype","httpVerb":"schema"},{"type":"link","label":"DiscountData","link":"/api/schemas/discountdata","routeSlug":"/api/schemas/discountdata","httpVerb":"schema"},{"type":"link","label":"EffortAdminCategoryData","link":"/api/schemas/effortadmincategorydata","routeSlug":"/api/schemas/effortadmincategorydata","httpVerb":"schema"},{"type":"link","label":"EffortData","link":"/api/schemas/effortdata","routeSlug":"/api/schemas/effortdata","httpVerb":"schema"},{"type":"link","label":"EffortTypeData","link":"/api/schemas/efforttypedata","routeSlug":"/api/schemas/efforttypedata","httpVerb":"schema"},{"type":"link","label":"EpicData","link":"/api/schemas/epicdata","routeSlug":"/api/schemas/epicdata","httpVerb":"schema"},{"type":"link","label":"ExternalCostData","link":"/api/schemas/externalcostdata","routeSlug":"/api/schemas/externalcostdata","httpVerb":"schema"},{"type":"link","label":"FileData","link":"/api/schemas/filedata","routeSlug":"/api/schemas/filedata","httpVerb":"schema"},{"type":"link","label":"FlexibleHoursData","link":"/api/schemas/flexiblehoursdata","routeSlug":"/api/schemas/flexiblehoursdata","httpVerb":"schema"},{"type":"link","label":"FlexibleSummaryData","link":"/api/schemas/flexiblesummarydata","routeSlug":"/api/schemas/flexiblesummarydata","httpVerb":"schema"},{"type":"link","label":"IncomingInvoiceBookingData","link":"/api/schemas/incominginvoicebookingdata","routeSlug":"/api/schemas/incominginvoicebookingdata","httpVerb":"schema"},{"type":"link","label":"IncomingInvoiceData","link":"/api/schemas/incominginvoicedata","routeSlug":"/api/schemas/incominginvoicedata","httpVerb":"schema"},{"type":"link","label":"IncomingInvoicePaymentAccountData","link":"/api/schemas/incominginvoicepaymentaccountdata","routeSlug":"/api/schemas/incominginvoicepaymentaccountdata","httpVerb":"schema"},{"type":"link","label":"IncomingInvoicePaymentBookingData","link":"/api/schemas/incominginvoicepaymentbookingdata","routeSlug":"/api/schemas/incominginvoicepaymentbookingdata","httpVerb":"schema"},{"type":"link","label":"IncomingInvoicePaymentData","link":"/api/schemas/incominginvoicepaymentdata","routeSlug":"/api/schemas/incominginvoicepaymentdata","httpVerb":"schema"},{"type":"link","label":"IncomingInvoiceStatus","link":"/api/schemas/incominginvoicestatus","routeSlug":"/api/schemas/incominginvoicestatus","httpVerb":"schema"},{"type":"link","label":"IncomingInvoiceType","link":"/api/schemas/incominginvoicetype","routeSlug":"/api/schemas/incominginvoicetype","httpVerb":"schema"},{"type":"link","label":"IncomingInvoiceVatData","link":"/api/schemas/incominginvoicevatdata","routeSlug":"/api/schemas/incominginvoicevatdata","httpVerb":"schema"},{"type":"link","label":"IntegrationData","link":"/api/schemas/integrationdata","routeSlug":"/api/schemas/integrationdata","httpVerb":"schema"},{"type":"link","label":"MetricData","link":"/api/schemas/metricdata","routeSlug":"/api/schemas/metricdata","httpVerb":"schema"},{"type":"link","label":"MetricReferenceData","link":"/api/schemas/metricreferencedata","routeSlug":"/api/schemas/metricreferencedata","httpVerb":"schema"},{"type":"link","label":"MetricTranslationData","link":"/api/schemas/metrictranslationdata","routeSlug":"/api/schemas/metrictranslationdata","httpVerb":"schema"},{"type":"link","label":"MilestoneData","link":"/api/schemas/milestonedata","routeSlug":"/api/schemas/milestonedata","httpVerb":"schema"},{"type":"link","label":"OfferData","link":"/api/schemas/offerdata","routeSlug":"/api/schemas/offerdata","httpVerb":"schema"},{"type":"link","label":"OfferLineItemData","link":"/api/schemas/offerlineitemdata","routeSlug":"/api/schemas/offerlineitemdata","httpVerb":"schema"},{"type":"link","label":"OfferStatus","link":"/api/schemas/offerstatus","routeSlug":"/api/schemas/offerstatus","httpVerb":"schema"},{"type":"link","label":"OfferUnitIntervalType","link":"/api/schemas/offerunitintervaltype","routeSlug":"/api/schemas/offerunitintervaltype","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoiceData","link":"/api/schemas/outgoinginvoicedata","routeSlug":"/api/schemas/outgoinginvoicedata","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoiceLineItemData","link":"/api/schemas/outgoinginvoicelineitemdata","routeSlug":"/api/schemas/outgoinginvoicelineitemdata","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoiceMasterData","link":"/api/schemas/outgoinginvoicemasterdata","routeSlug":"/api/schemas/outgoinginvoicemasterdata","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoiceMasterType","link":"/api/schemas/outgoinginvoicemastertype","routeSlug":"/api/schemas/outgoinginvoicemastertype","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoicePaymentBookingData","link":"/api/schemas/outgoinginvoicepaymentbookingdata","routeSlug":"/api/schemas/outgoinginvoicepaymentbookingdata","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoicePaymentStatus","link":"/api/schemas/outgoinginvoicepaymentstatus","routeSlug":"/api/schemas/outgoinginvoicepaymentstatus","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoiceReferenceData","link":"/api/schemas/outgoinginvoicereferencedata","routeSlug":"/api/schemas/outgoinginvoicereferencedata","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoiceStatus","link":"/api/schemas/outgoinginvoicestatus","routeSlug":"/api/schemas/outgoinginvoicestatus","httpVerb":"schema"},{"type":"link","label":"OutgoingInvoiceType","link":"/api/schemas/outgoinginvoicetype","routeSlug":"/api/schemas/outgoinginvoicetype","httpVerb":"schema"},{"type":"link","label":"OvertimeHoursData","link":"/api/schemas/overtimehoursdata","routeSlug":"/api/schemas/overtimehoursdata","httpVerb":"schema"},{"type":"link","label":"OvertimeSummaryData","link":"/api/schemas/overtimesummarydata","routeSlug":"/api/schemas/overtimesummarydata","httpVerb":"schema"},{"type":"link","label":"PaymentAccountData","link":"/api/schemas/paymentaccountdata","routeSlug":"/api/schemas/paymentaccountdata","httpVerb":"schema"},{"type":"link","label":"PaymentAccountType","link":"/api/schemas/paymentaccounttype","routeSlug":"/api/schemas/paymentaccounttype","httpVerb":"schema"},{"type":"link","label":"PaymentBookingData","link":"/api/schemas/paymentbookingdata","routeSlug":"/api/schemas/paymentbookingdata","httpVerb":"schema"},{"type":"link","label":"PaymentData","link":"/api/schemas/paymentdata","routeSlug":"/api/schemas/paymentdata","httpVerb":"schema"},{"type":"link","label":"PdfTemplateData","link":"/api/schemas/pdftemplatedata","routeSlug":"/api/schemas/pdftemplatedata","httpVerb":"schema"},{"type":"link","label":"PhaseData","link":"/api/schemas/phasedata","routeSlug":"/api/schemas/phasedata","httpVerb":"schema"},{"type":"link","label":"PhaseGroupData","link":"/api/schemas/phasegroupdata","routeSlug":"/api/schemas/phasegroupdata","httpVerb":"schema"},{"type":"link","label":"PhaseTypeData","link":"/api/schemas/phasetypedata","routeSlug":"/api/schemas/phasetypedata","httpVerb":"schema"},{"type":"link","label":"PositionData","link":"/api/schemas/positiondata","routeSlug":"/api/schemas/positiondata","httpVerb":"schema"},{"type":"link","label":"ProjectData","link":"/api/schemas/projectdata","routeSlug":"/api/schemas/projectdata","httpVerb":"schema"},{"type":"link","label":"ProjectGroupData","link":"/api/schemas/projectgroupdata","routeSlug":"/api/schemas/projectgroupdata","httpVerb":"schema"},{"type":"link","label":"ProjectPortfolioData","link":"/api/schemas/projectportfoliodata","routeSlug":"/api/schemas/projectportfoliodata","httpVerb":"schema"},{"type":"link","label":"ProjectStatusUpdateData","link":"/api/schemas/projectstatusupdatedata","routeSlug":"/api/schemas/projectstatusupdatedata","httpVerb":"schema"},{"type":"link","label":"ProjectTagData","link":"/api/schemas/projecttagdata","routeSlug":"/api/schemas/projecttagdata","httpVerb":"schema"},{"type":"link","label":"ProjectTypeData","link":"/api/schemas/projecttypedata","routeSlug":"/api/schemas/projecttypedata","httpVerb":"schema"},{"type":"link","label":"SpaceData","link":"/api/schemas/spacedata","routeSlug":"/api/schemas/spacedata","httpVerb":"schema"},{"type":"link","label":"SupplierCategoryData","link":"/api/schemas/suppliercategorydata","routeSlug":"/api/schemas/suppliercategorydata","httpVerb":"schema"},{"type":"link","label":"SupplierData","link":"/api/schemas/supplierdata","routeSlug":"/api/schemas/supplierdata","httpVerb":"schema"},{"type":"link","label":"SupplierFullData","link":"/api/schemas/supplierfulldata","routeSlug":"/api/schemas/supplierfulldata","httpVerb":"schema"},{"type":"link","label":"TagData","link":"/api/schemas/tagdata","routeSlug":"/api/schemas/tagdata","httpVerb":"schema"},{"type":"link","label":"TaskData","link":"/api/schemas/taskdata","routeSlug":"/api/schemas/taskdata","httpVerb":"schema"},{"type":"link","label":"TaskDueDateRecurringType","link":"/api/schemas/taskduedaterecurringtype","routeSlug":"/api/schemas/taskduedaterecurringtype","httpVerb":"schema"},{"type":"link","label":"TaskDueDateSettingsData","link":"/api/schemas/taskduedatesettingsdata","routeSlug":"/api/schemas/taskduedatesettingsdata","httpVerb":"schema"},{"type":"link","label":"TaskPriorityOptionData","link":"/api/schemas/taskpriorityoptiondata","routeSlug":"/api/schemas/taskpriorityoptiondata","httpVerb":"schema"},{"type":"link","label":"TaskStatus","link":"/api/schemas/taskstatus","routeSlug":"/api/schemas/taskstatus","httpVerb":"schema"},{"type":"link","label":"TeamMemberData","link":"/api/schemas/teammemberdata","routeSlug":"/api/schemas/teammemberdata","httpVerb":"schema"},{"type":"link","label":"UserData","link":"/api/schemas/userdata","routeSlug":"/api/schemas/userdata","httpVerb":"schema"},{"type":"link","label":"UserFullData","link":"/api/schemas/userfulldata","routeSlug":"/api/schemas/userfulldata","httpVerb":"schema"},{"type":"link","label":"UsergroupData","link":"/api/schemas/usergroupdata","routeSlug":"/api/schemas/usergroupdata","httpVerb":"schema"},{"type":"link","label":"UserPlan","link":"/api/schemas/userplan","routeSlug":"/api/schemas/userplan","httpVerb":"schema"},{"type":"link","label":"UserType","link":"/api/schemas/usertype","routeSlug":"/api/schemas/usertype","httpVerb":"schema"},{"type":"link","label":"WebhookCreateData","link":"/api/schemas/webhookcreatedata","routeSlug":"/api/schemas/webhookcreatedata","httpVerb":"schema"},{"type":"link","label":"WebhookData","link":"/api/schemas/webhookdata","routeSlug":"/api/schemas/webhookdata","httpVerb":"schema"},{"type":"link","label":"WebhookEvent","link":"/api/schemas/webhookevent","routeSlug":"/api/schemas/webhookevent","httpVerb":"schema"},{"type":"link","label":"WorkTimeDayData","link":"/api/schemas/worktimedaydata","routeSlug":"/api/schemas/worktimedaydata","httpVerb":"schema"},{"type":"link","label":"WorkTimePeriodData","link":"/api/schemas/worktimeperioddata","routeSlug":"/api/schemas/worktimeperioddata","httpVerb":"schema"},{"type":"link","label":"WorkTimeUnitData","link":"/api/schemas/worktimeunitdata","routeSlug":"/api/schemas/worktimeunitdata","httpVerb":"schema"}]}]}