API reference

Base URL: https://couplrfsm.com/api/v1. API version: v1.

These pages are generated from the OpenAPI specification, which is tested against the running API. Authentication is described in Authentication and API keys. Error format, pagination, rate limits and idempotency are described in Errors, limits and retries.

Resources#

• Customers: List, find, create and update customers, and add service addresses to them.
• Jobs: List, create and update jobs.
• Lookup lists: Short lists of the job types, technicians, tags, lead sources and market segments a job refers to by id.
• Invoices: List and read invoices with their line items, and create draft invoices.
• Payments: Read the payments collected on invoices and what has been refunded.
• Price book: List, read, create and update the items a company puts on invoices and estimates.
• Estimates: List and read estimates, create one with the simple layout, and email it to the customer.
• Schedules and time: Read time entries (who worked when) and the schedule blocks that are not jobs.
• Notes: Read the notes on a customer or a job, and add a note.
• Photos and documents: Time-limited links to the photos on a job or a customer, and to a customer's documents.
• Equipment: Read the equipment installed at a customer's addresses.
• Booking: Find open time slots and book a visit into one.
• Maintenance plans: Read the maintenance plans a company sells and which customers are enrolled in them, and enroll a customer.
• Leads: List and read the leads Couplr's assistant is talking to, and add a lead.
• Webhook subscriptions: Add, change and remove the destinations Couplr sends events to.
• Deleted records: Learn which customers, jobs, invoices and estimates were removed, to keep a copy in step.
• Account: Identify the API key in use.

Conventions#

Used by every endpoint:

• Send and receive JSON. Records come back inside data.
• In examples, replace YOUR_API_KEY with your key and YOUR_UNIQUE_KEY with a unique string per operation. Ids such as 1842 are examples.
• Request fields that are not listed are ignored. A field you omit keeps its value on update, or takes its default on create.
• Timestamps are ISO 8601 in UTC unless a field says otherwise. Dates are YYYY-MM-DD.
• Customer, job, estimate and lead ids are integers. Invoice ids are UUID strings.
• Money is in US dollars. Invoice amount and line rate are decimal strings such as "389.00". Estimate total is a number.

All endpoints#

Shared objects#

Returned by every resource. Each resource's own object is described on its page.

Page metadata object#

Error object#

RFC 9457 problem details, plus code, request_id, and the older message / errors members.