API reference

Every operation an API key can use, written from the same contract the web and iPhone apps are built on. There are 102 of them.

Send a request

The API is at https://app.tradesender.co.uk. Send your key in the Authorization header, and an Idempotency-Key of your own making with anything that changes data, so a retry is not carried out twice.

curl "https://app.tradesender.co.uk/api/v1/customers" \
  -H "Authorization: Bearer $TRADESENDER_KEY"

Make a key in the app under Settings, then API keys. A key works as you, with your access, from a server. It cannot change settings, the team or the plan.

Sections

• CustomersCustomers, their contacts and the properties you look after.18
• ServicesThe price list quotes, jobs and invoices are built from.5
• QuotesWrite a quote, send it, record the answer and turn it into a job.11
• Jobs and visitsJobs, the visits that carry them out, repeating visits, photos and time.32
• Calendar and time offWho is where in a range of dates, and when people are away.8
• Invoices and paymentsRaise an invoice, send it, record payments and void it.18
• EnquiriesWhat people send through a website form, and the form itself.6
• Workspace and teamWho the key belongs to, the workspace it works in and its members.4

Errors

A request the API refuses answers with a status from 400 to 499 and this body. Read code in your program and show detail to a person.

• errorsarray of objectrequired

  Each item(4)

  • codestringrequired

  • detailstringrequired

  • sourceobject

    Fields(1)

    • pointerstring

  • metaobject