| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://{yourdomain}.clientary.com/api/v2 | link | — | — | — |
Actions (81)
Invoices · 12
- Create invoicePOST /api/v2/invoices
Create a new invoice.
documented - Create invoice for clientPOST /api/v2/clients/{client_id}/invoices
Create an invoice for a specific client.
documented - Delete invoiceDELETE /api/v2/invoices/{id}
Delete an invoice.
documented - Get invoiceGET /api/v2/invoices/{id}
Retrieve a single invoice.
documented - List invoicesGET /api/v2/invoices
Return a paginated list of invoices.
documented - List invoices (page 2)GET /api/v2/invoices?page=2
Second page of invoices.
documented - List invoices for a clientGET /api/v2/clients/{client_id}/invoices
Invoices for a specific client.
documented - List invoices for a projectGET /api/v2/projects/{project_id}/invoices
Invoices for a specific project.
documented - List invoices for a recurring scheduleGET /api/v2/recurring/{id}/invoices
Invoices for a recurring schedule.
documented - List invoices updated sinceGET /api/v2/invoices?updated_since={date}
Filter invoices by update time.
documented - Send invoicePOST /api/v2/invoices/{id}/messages
Send an invoice via email.
documented - Update invoicePUT /api/v2/invoices/{id}
Update an invoice.
documented
Clients · 8
- Create clientPOST /api/v2/clients
Create a new client.
documented - Delete clientDELETE /api/v2/clients/{id}
Delete a client and all associated data.
documented - Get clientGET /api/v2/clients/{id}
Retrieve a single client by ID.
documented - List clientsGET /api/v2/clients
Return a paginated list of clients.
documented - List clients (page 2)GET /api/v2/clients?page=2
Second page of the clients list.
documented - List clients sorted by dateGET /api/v2/clients?sort=date
List clients ordered by creation date.
documented - List clients updated sinceGET /api/v2/clients?updated_since={date}
Filter clients by update time to fetch latest changes.
documented - Update clientPUT /api/v2/clients/{id}
Update an existing client (partial fields allowed).
documented
Contacts · 8
- Create contactPOST /api/v2/clients/{client_id}/contacts
Create a new contact under a client.
documented - Delete contactDELETE /api/v2/contacts/{id}
Delete a contact.
documented - Get contactGET /api/v2/contacts/{id}
Retrieve a contact by ID.
documented - List contactsGET /api/v2/contacts
List contacts across all clients.
documented - List contacts (page 2)GET /api/v2/contacts?page=2
Second page of the contacts list.
documented - List contacts for a clientGET /api/v2/clients/{client_id}/contacts
List contacts associated with a specific client.
documented - List contacts with custom page sizeGET /api/v2/contacts?page_size={size}
Retrieve a page of contacts with a custom page size.
documented - Update contactPUT /api/v2/contacts/{id}
Update a contact.
documented
Estimates · 8
- Create estimatePOST /api/v2/estimates
Create an estimate.
documented - Delete estimateDELETE /api/v2/estimates/{id}
Delete an estimate.
documented - Get estimateGET /api/v2/estimates/{id}
Retrieve an estimate.
documented - List estimatesGET /api/v2/estimates
List estimates.
documented - List estimates for a clientGET /api/v2/clients/{client_id}/estimates
List estimates for a client.
documented - List estimates for a projectGET /api/v2/projects/{project_id}/estimates
List estimates for a project.
documented - Send estimatePOST /api/v2/estimates/{id}/messages
Send an estimate via email.
documented - Update estimatePUT /api/v2/estimates/{id}
Update an estimate.
documented
Expenses · 7
- Create expensePOST /api/v2/expenses
Create an expense.
documented - Delete expenseDELETE /api/v2/expenses/{id}
Delete an expense.
documented - Get expenseGET /api/v2/expenses/{id}
Retrieve an expense.
documented - List expensesGET /api/v2/expenses
List expenses by date range (default fiscal year).
documented - List expenses for a clientGET /api/v2/clients/{client_id}/expenses
List expenses for a client.
documented - List expenses for a projectGET /api/v2/projects/{project_id}/expenses
List expenses for a project.
documented - Update expensePUT /api/v2/expenses/{id}
Update an expense.
documented
Leads · 7
- Create leadPOST /api/v2/Lead
Create a new lead.
documented - Delete leadDELETE /api/v2/leads/{id}
Delete a lead.
documented - Get leadGET /api/v2/leads/{id}
Retrieve a lead by ID.
documented - List leadsGET /api/v2/leads
Return a paginated list of leads.
documented - List leads (page 2)GET /api/v2/leads?page=2
Second page of leads.
documented - List leads sorted by nameGET /api/v2/leads?sort=name
Leads sorted by name.
documented - Update leadPUT /api/v2/leads/{id}
Update a lead.
documented
Projects · 6
- Create projectPOST /api/v2/projects
Create a new project.
documented - Delete projectDELETE /api/v2/projects/{id}
Delete a project and related data.
documented - Get projectGET /api/v2/projects/{id}
Retrieve a single project by ID.
documented - List projectsGET /api/v2/projects
Return a paginated list of projects.
documented - List projects for a clientGET /api/v2/clients/{client_id}/projects
Return projects that belong to a specific client.
documented - Update projectPUT /api/v2/projects/{id}
Update an existing project.
documented
Tasks · 6
- Create taskPOST /api/v2/task
Create a new task.
documented - Delete taskDELETE /api/v2/tasks/{id}
Delete a task.
documented - Get taskGET /api/v2/tasks/{id}
Retrieve a task by ID.
documented - List tasksGET /api/v2/tasks
Retrieve a paginated list of tasks.
documented - List tasks for a projectGET /api/v2/projects/{project_id}/tasks
List tasks for a specific project.
documented - Update taskPUT /api/v2/tasks/{id}
Update a task.
documented
Hours · 5
- Create hourPOST /api/v2/projects/{project_id}/hours
Create a new hour entry for a project.
documented - Delete hourDELETE /api/v2/hours/{id}
Delete an hour entry.
documented - Get hourGET /api/v2/hours/{id}
Retrieve an hour entry by ID.
documented - List hours for a projectGET /api/v2/projects/{project_id}/hours
List hours for a project.
documented - Update hourPUT /api/v2/hours/{id}
Update an hour entry.
documented
Recurring Schedules · 5
- Create recurring schedulePOST /api/v2/recurring
Create a new recurring schedule.
documented - Delete recurring scheduleDELETE /api/v2/recurring/{id}
Delete a recurring schedule.
documented - Get recurring scheduleGET /api/v2/recurring/{id}
Retrieve a specific recurring schedule.
documented - List recurring schedulesGET /api/v2/recurring/
Retrieve recurring schedules.
documented - Update recurring schedulePUT /api/v2/recurring/{id}
Update a recurring schedule.
documented
Payments · 4
- Delete invoice paymentDELETE /api/v2/invoices/{invoice_id}/payments/{id}
Delete a payment for an invoice.
documented - List paymentsGET /api/v2/payments
Retrieve payments.
documented - Post a new invoice paymentPOST /api/v2/invoices/{invoice_id}/payments
Create a payment for an invoice.
documented - Post a new invoice payment (auto-charge)POST /api/v2/invoices/{invoice_id}/payments
Charge the outstanding amount using a payment profile.
documented
Payment Profiles · 3
- Create payment profilePOST /api/v2/clients/{client_id}/payment_profiles
Create a payment profile for a client.
documented - Delete payment profileDELETE /api/v2/clients/{client_id}/payment_profiles/{id}
Delete a client's payment profile.
documented - List payment profilesGET /api/v2/clients/{client_id}/payment_profiles
Retrieve payment profiles for a client.
documented