Reference · v1.0.0
API reference
155 endpoints across 24 resources. Generated from the same OpenAPI document the API's own contract tests check, so what you read here is what the API does.
https://api.closepact.com/v1/apiEvery request needs Authorization: Bearer cp_live_… — see Authentication. Errors share one shape — see Errors.
Getting started
Account
The API key itself: which organization it belongs to, who it acts as, and what the organization holds.
Sales
Contacts
The people you deal with at your customers: name, e-mail, title and phone, optionally attached to a customer.
Deals
The opportunities in your pipeline: what is being sold, to whom, for how much, and how far it has come.
Products
The product catalogue quotes are built from: what you sell, its SKU, unit price in öre, whether it recurs, and any custom fields (propertie…
Proposals
Written proposals, edited in the panel's editor as a tree of blocks (headings, paragraphs, lists, images, pricing tables…).
- GET
/proposalsList proposals - POST
/proposalsCreate a proposal - GET
/proposals/{proposal}Retrieve a proposal - PATCH
/proposals/{proposal}Replace a proposal's content - DELETE
/proposals/{proposal}Delete a proposal - PATCH
/proposals/{proposal}/renameRename a proposal - POST
/proposals/{proposal}/publishPublish a proposal
Quotes
Priced offers built from lines — from your product catalogue or free text — with VAT on each line, an optional quote-level discount and an…
- GET
/quotesList quotes - POST
/quotesCreate a quote - GET
/quotes/{quote}Retrieve a quote - PATCH
/quotes/{quote}Update a quote - DELETE
/quotes/{quote}Delete a quote - POST
/quotes/{quote}/sendSend a quote - POST
/quotes/{quote}/revert-to-draftRevert a quote to draft - POST
/quotes/{quote}/convertHand over an accepted quote - POST
/quotes/{quote}/linesAdd a line - PATCH
/quotes/{quote}/lines/{line}Update a line - DELETE
/quotes/{quote}/lines/{line}Delete a line
Rooms
Deal rooms: the branded page a buyer opens to read your offer, watch videos, download documents and accept a quote.
Room stakeholders
The buyer-side people invited into a room.
Room contents
The blocks a room is built from — text, links, videos, documents, proposals and quotes — arranged in sections.
Documents & e-signing
Documents
Files you send for reading or signing: upload a contract, add recipients, send it, follow what happens to it and download it again.
- GET
/documentsList documents - POST
/documentsUpload a document - GET
/documents/{document}Retrieve a document - PATCH
/documents/{document}Update a document - DELETE
/documents/{document}Delete a document - GET
/documents/{document}/download-linkGet a download link - GET
/documents/{document}/timelineGet a document's history - GET
/documents/{document}/engagementGet reading statistics - GET
/documents/{document}/recipientsList recipients - POST
/documents/{document}/recipientsAdd a recipient - DELETE
/documents/{document}/recipients/{recipient}Remove a recipient - POST
/documents/{document}/sendSend for signing - POST
/documents/{document}/remindRemind recipients
Signature requests
A signature request (an envelope) is one round of sending a document for signing: who must sign, in which order, by when, and the tamper-ev…
Templates
Reusable starting points for deal rooms, documents, proposals, mutual action plans and emails.
Booking
Employees
The people who can be sent to jobs (personal), their weekly working hours and their skills.
- GET
/employeesList employees - POST
/employeesCreate an employee - GET
/employees/{employee}Get an employee - PATCH
/employees/{employee}Update an employee - DELETE
/employees/{employee}Delete an employee - GET
/employees/{employee}/availabilityList an employee's working hours - POST
/employees/{employee}/availabilityAdd working hours - PATCH
/employees/{employee}/availability/{rule}Change working hours - DELETE
/employees/{employee}/availability/{rule}Remove working hours - GET
/skillsList skills
Recurrences
Standing agreements (återkommande avtal): a customer, a template job and an iCalendar rule.
Services
The service catalogue (tjänster): price, VAT rate, ROT/RUT eligibility, usual duration and the skills each service requires.
Time entries
Reported time (tidrapporter): clocked in and out in the field app, approved in the office, and read here for payroll.
Work orders
Jobs (uppdrag): create them from a webshop or CRM, follow them through their statuses, complete them from the field with checklist, materia…
- GET
/work-ordersList work orders - POST
/work-ordersCreate a work order - GET
/work-orders/{workOrder}Get a work order - PATCH
/work-orders/{workOrder}Update a work order - DELETE
/work-orders/{workOrder}Delete a work order - POST
/work-orders/{workOrder}/statusChange the status of a work order - POST
/work-orders/{workOrder}/completeComplete a work order - GET
/work-orders/{workOrder}/invoice-basisGet the invoice basis of a work order - GET
/work-orders/{workOrder}/checklistList the checklist of a work order - POST
/work-orders/{workOrder}/checklistAdd a checklist item - PATCH
/work-orders/{workOrder}/checklist/{item}Tick or change a checklist item - DELETE
/work-orders/{workOrder}/checklist/{item}Remove a checklist item - GET
/work-orders/{workOrder}/materialsList the materials of a work order - POST
/work-orders/{workOrder}/materialsAdd a material line - PATCH
/work-orders/{workOrder}/materials/{material}Change a material line - DELETE
/work-orders/{workOrder}/materials/{material}Remove a material line
Schedule
Placing work: assign employees to jobs, move jobs in time, and find double bookings.
Invoicing
Articles
The price list (artikelregister) invoices are built from: what you sell, its price in öre, its VAT rate, its BAS account and whether it can…
Invoices
Customer invoices (kundfakturor) and credit notes, from draft to paid.
- GET
/invoicesList invoices - POST
/invoicesCreate an invoice draft - POST
/invoices/from-work-ordersCreate a draft from finished work orders - GET
/invoices/{invoice}Get an invoice - PATCH
/invoices/{invoice}Update an invoice draft - DELETE
/invoices/{invoice}Delete an invoice draft - POST
/invoices/{invoice}/sendSend (issue) an invoice - POST
/invoices/{invoice}/creditCredit an issued invoice - GET
/invoices/{invoice}/pdfDownload the PDF - GET
/invoices/{invoice}/remindersList an invoice's payment reminders
Invoice lines
The rows of an invoice.
Customers
Customers
The customer register (kundregister): the companies and private persons you quote, carry out work for and invoice.
- GET
/customersList customers - POST
/customersCreate a customer - GET
/customers/{account}Get a customer - PATCH
/customers/{account}Update a customer - DELETE
/customers/{account}Delete a customer - POST
/customers/{account}/addressesAdd an address - PATCH
/customers/{account}/addresses/{address}Update an address - DELETE
/customers/{account}/addresses/{address}Delete an address
Webhooks
Webhooks
Webhooks tell your system the moment something happens in Closepact — a deal is won, a document is signed, a work order is completed, an in…
- GET
/webhooksList webhook endpoints - POST
/webhooksCreate a webhook endpoint - GET
/webhooks/{endpoint}Retrieve a webhook endpoint - PATCH
/webhooks/{endpoint}Update a webhook endpoint - DELETE
/webhooks/{endpoint}Delete a webhook endpoint - GET
/webhooks/{endpoint}/deliveriesList an endpoint's deliveries - POST
/webhooks/{endpoint}/testSend a test event - POST
/webhooks/{endpoint}/rotate-secretRotate the signing secret
Webhook events
Event catalogue
19 events Closepact can send to your endpoints, with their payloads.