| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://app.paymoapp.com/api/ | link | — | — | — |
Actions (155)
Estimate Templates · 12
- Create estimate templatePOST /estimate_templates
Create a new estimate template.
documented - Create estimate templatePOST /estimate_templates
Create a new estimate template.
documented - Delete estimate templateDELETE /estimate_templates/{template_id}
Delete an estimate template.
documented - Delete estimate templateDELETE /estimate_templates/{template_id}
Delete an estimate template.
documented - Get estimate templateGET /estimate_templates/{template_id}
Retrieve an estimate template.
documented - Get estimate templateGET /estimate_templates/{template_id}
Retrieve an estimate template.
documented - Get estimate template with itemsGET /estimate_templates/{template_id}?include=estimateitems
Retrieve an estimate template with included estimate items.
documented - Get estimate template with itemsGET /estimate_templates/{template_id}?include=estimateitems
Retrieve an estimate template with included estimate items.
documented - List estimate templatesGET /estimate_templates
List estimate templates.
documented - List estimate templatesGET /estimate_templates
List estimate templates.
documented - Update estimate template
Update an estimate template.
documented - Update estimate template
Update an estimate template.
documented
Invoices · 12
- Create invoicePOST /invoices
Create a new invoice (with optional items).
documented - Create invoice paymentPOST /invoicepayments
Create a new invoice payment.
documented - Delete invoiceDELETE /invoices/{invoice_id}
Delete an invoice.
documented - Delete invoice paymentDELETE /invoicepayments/{payment_id}
Delete an invoice payment.
documented - Get invoiceGET /invoices/{invoice_id}
Retrieve an invoice.
documented - Get invoice paymentGET /invoicepayments/{payment_id}
Retrieve a single invoice payment.
documented - List invoice itemsGET /invoiceitems
List invoice items.
documented - List invoice paymentsGET /invoicepayments
List payments for invoices.
documented - List invoicesGET /invoices
List invoices.
documented - List invoicesGET /invoices
List all invoices with optional filters.
documented - Update invoice
Update an existing invoice (including items).
documented - Update invoice payment
Update an existing invoice payment.
documented
Estimates · 11
- Create estimatePOST /estimates
Create a new estimate.
documented - Create estimatePOST /estimates
Create a new estimate.
documented - Delete estimateDELETE /estimates/{estimate_id}
Delete an estimate.
documented - Delete estimateDELETE /estimates/{estimate_id}
Delete an estimate.
documented - Get estimateGET /estimates/{estimate_id}
Retrieve an estimate.
documented - Get estimateGET /estimates/{estimate_id}
Retrieve an estimate.
documented - Get estimate with itemsGET /estimates/{estimate_id}?include=estimateitems
Retrieve an estimate with its items.
documented - List estimatesGET /estimates
List estimates.
documented - List estimatesGET /estimates
List estimates.
documented - Update estimate
Update an existing estimate.
documented - Update estimate
Update an existing estimate.
documented
Projects · 11
- Add tasks from template
Add tasks from a project template to a project (or re-use a template).
documented - Create projectPOST /projects
Create a new project.
documented - Delete projectDELETE /projects/{project_id}
Delete a project.
documented - Get projectGET /projects/{project_id}
Retrieve a project.
documented - Get project with tasksGET /projects/{project_id}?include=tasks
Get a project including its tasks.
documented - Get project with tasksGET /projects/{project_id}?include=tasks
Get a project including its tasks.
documented - List project entriesGET /projects/{project_id}?include=tasks.entries
Include related entries on project fetch.
documented - List projectsGET /projects
List projects.
documented - List projectsGET /projects
List projects.
documented - Update project
Update a project.
documented - Update tasklists orderPUT /projects/{project_id}
Change the order of task lists within a project.
documented
Files · 10
- Delete fileDELETE /files/{file_id}
Delete a file.
documented - Delete fileDELETE /files/{file_id}
Delete a file.
documented - Get fileGET /files/{file_id}
Retrieve a file.
documented - Get fileGET /files/{file_id}
Retrieve a file (by ID).
documented - List filesGET /files
List files.
documented - List filesGET /files
List files.
documented - Update file
Update a file.
documented - Update file
Update a file.
documented - Upload filePOST /files
Upload a new file.
documented - Upload filePOST /files
Upload a new file.
documented
Project Templates · 10
- Create project templatePOST /projecttemplates
Create a new project template.
documented - Create project templatePOST /projecttemplates
Create a new project template.
documented - Delete project templateDELETE /projecttemplates/{template_id}
Delete a project template.
documented - Delete project templateDELETE /projecttemplates/{template_id}
Delete a project template.
documented - Get project templateGET /projecttemplates/{template_id}
Retrieve a project template.
documented - Get project templateGET /projecttemplates/{template_id}
Retrieve a project template.
documented - List project templatesGET /projecttemplates
List project templates.
documented - List project templatesGET /projecttemplates
List project templates.
documented - Update project template
Update a project template.
documented - Update project template
Update a project template.
documented
Reports · 10
- Create reportPOST /reports
Create a report.
documented - Create reportPOST /reports
Create a report.
documented - Delete reportDELETE /reports/{report_id}
Delete a report.
documented - Delete reportDELETE /reports/{report_id}
Delete a report.
documented - Get reportGET /reports/{report_id}
Retrieve a report.
documented - Get reportGET /reports/{report_id}
Retrieve a report.
documented - List reportsGET /reports
List reports.
documented - List reportsGET /reports
List reports.
documented - Update report
Update a report.
documented - Update report
Update a report.
documented
Tasks · 10
- Attach file to taskPOST /tasks
Attach a file to a task.
documented - Change task priority
Update a task's priority.
documented - Change task status
Update a task's status.
documented - Create taskPOST /tasks
Create a new task.
documented - Delete taskDELETE /tasks/{task_id}
Delete a task.
documented - Get taskGET /tasks/{task_id}
Retrieve a task.
documented - List task with commentsGET /tasks?include=thread.comments
Fetch a task with its comments.
documented - List tasksGET /tasks
List tasks.
documented - Update subtasks order
Reorder subtasks within a task.
documented - Update task
Update a task.
documented
Time Entries · 10
- Create time entryPOST /entries
Create a time entry or start a timer.
documented - Create time entryPOST /entries
Create a time entry or start a timer.
documented - Delete time entryDELETE /entries/{entry_id}
Delete a time entry.
documented - Delete time entryDELETE /entries/{entry_id}
Delete a time entry.
documented - Get time entryGET /entries/{entry_id}
Get a time entry.
documented - Get time entryGET /entries/{entry_id}
Get a time entry.
documented - List time entriesGET /entries
List time entries.
documented - List time entriesGET /entries
List time entries.
documented - Update time entry
Update a time entry.
documented - Update time entry
Update a time entry.
documented
Authentication · 8
- Create sessionPOST /sessions
Create a new session token.
documented - Create sessionPOST /sessions
Create a new session token.
documented - Delete sessionDELETE /sessions/{session_id}
End a session (invalidate token).
documented - Delete sessionDELETE /sessions/{session_id}
End a session (invalidate token).
documented - Get current user infoGET /me
Get data for the authenticated user.
documented - Get current user infoGET /me
Get data for the authenticated user.
documented - List sessionsGET /sessions
List sessions for the current user.
documented - List sessionsGET /sessions
List sessions for the current user.
documented
Milestones · 7
- Complete milestonePOST /milestones/{milestone_id}
Mark a milestone as complete.
documented - Create milestonePOST /milestones
Create a milestone.
documented - Delete milestoneDELETE /milestones/{milestone_id}
Delete a milestone.
documented - Get milestoneGET /milestones/{milestone_id}
Retrieve a milestone.
documented - List milestonesGET /milestones
List milestones.
documented - List milestonesGET /milestones
List milestones.
documented - Update milestone
Update a milestone.
documented
Bookings · 6
- Create bookingPOST /bookings
Create a new booking with required fields.
documented - Delete bookingDELETE /bookings/{booking_id}
Delete a booking.
documented - Get bookingGET /bookings/{booking_id}
Retrieve a single booking by ID.
documented - List bookingsGET /bookings
List bookings with optional where filters (e.g., by project, task, user, date interval).
documented - Update bookingPUT /bookings/{booking_id}
Update an existing booking.
documented - Update bookingPOST /bookings/{booking_id}
Update an existing booking (alternative method).
documented
Client Contacts · 6
- Create client contactPOST /clientcontacts
Create a new client contact.
documented - Delete client contactDELETE /clientcontacts/{contact_id}
Delete a client contact.
documented - Get client contactGET /clientcontacts/{contact_id}
Retrieve a single client contact by ID.
documented - List client contactsGET /clientcontacts
List all client contacts, or for a specific client.
documented - Update client contactPUT /clientcontacts/{contact_id}
Update an existing client contact.
documented - Update client contactPOST /clientcontacts/{contact_id}
Update an existing client contact (including image upload).
documented
Discussions · 6
- Attach file to discussionPOST /discussions/{discussion_id}
Attach a file to a discussion.
documented - Create discussionPOST /discussions
Create a new discussion.
documented - Delete discussionDELETE /discussions/{discussion_id}
Delete a discussion.
documented - Get discussionGET /threads/{thread_id}
Retrieve a discussion and its thread.
documented - List discussionsGET /threads
List all discussions (threads) for projects.
documented - Update discussion
Update discussion details.
documented
Expenses · 6
- Attach receipt to expensePOST /expenses/{expense_id}
Attach a receipt to an expense.
documented - Create expensePOST /expenses
Create an expense.
documented - Delete expenseDELETE /expenses/{expense_id}
Delete an expense.
documented - Get expenseGET /expenses/{expense_id}
Retrieve an expense.
documented - List expensesGET /expenses
List expenses.
documented - Update expense
Update an expense.
documented
Invoice Templates · 6
- Create invoice templatePOST /invoicetemplates
Create a new invoice template.
documented - Delete invoice templateDELETE /invoicetemplates/{template_id}
Delete an invoice template.
documented - Get invoice templateGET /invoicetemplates/{template_id}
Retrieve a specific invoice template.
documented - List invoice templatesGET /invoicetemplates
List available invoice templates.
documented - List invoice templates galleryGET /invoicetemplatesgallery
List Paymo library invoice templates.
documented - Update invoice template
Update an existing invoice template.
documented
Task Lists · 6
- Create task listPOST /tasklists
Create a task list.
documented - Delete task listDELETE /tasklists/{tasklist_id}
Delete a task list.
documented - Get task listGET /tasklists/{tasklist_id}
Retrieve a task list.
documented - List task listsGET /tasklists
List task lists.
documented - Update task list
Update a task list.
documented - Update tasks orderPUT /tasklists/{tasklist_id}
Change the order of tasks in a task list.
documented
Clients · 5
- Create clientPOST /clients
Create a new client.
documented - Delete clientDELETE /clients/{client_id}
Delete a client (and related data).
documented - Get clientGET /clients/{client_id}
Retrieve a single client by ID.
documented - List clientsGET /clients
List all clients.
documented - Update client
Update an existing client.
documented