Overview

The Schedulinq API connects your own system — usually your CRM — to Schedulinq. Your system creates the work; Schedulinq plans it, sends the invitations and keeps the agenda. This chapter is written for the developer who builds the connection and for the admin who sets it up in Schedulinq, side by side: some steps happen in your code, some in the dashboard.

What you can build

Three buttons in your CRM, each one HTTP call from your server to ours:

• Plan opens Schedulinq's planner on a lead and a team member, with everything already filled in. The caller picks a time and saves. See Planning links.
• Invite sends the customer an invitation to book a time with the team member you chose, in one call. See Invitations.
• Create buyer invites someone into your organisation as a team member. See Colleagues.

Webhooks report every change back to your system: an appointment booked, moved or cancelled, an invitation used, a team member who accepted. See Webhooks.

How your world maps onto Schedulinq

• A lead becomes a customer, one per lead. Customers are found by e-mail address, so the same person is not created twice.
• A buyer or installer becomes a team member, with their own working hours, service areas and calendar.
• A caller is a team member who may plan: the person in your CRM who presses Plan.
• Your deal and campaign ids become metadata — your own references, carried on invitations, appointments and team-member invitations. See Metadata.

Who sets up what

• Admins manage the API keys, the webhooks and the allowed return addresses under Integrations → API. Nobody else sees that page.
• Callers need a role that may create appointments and see all appointments and customers.
• Buyers typically get a role that sees only their own appointments and no customers. See Colleagues.
• Keys and webhooks belong to the organisation. They see every appointment, invitation and team member, whatever a team member's role — roles are a rule of the dashboard, not of the API. A CRM that serves several competing buyers keeps them apart itself.

What the API deliberately does not do

• It does not create appointments directly. The planner is the path: a person picks the time, with the agenda, the drive and the service area in view.
• It does not cancel an invitation.
• It does not set services, service areas or working hours. An admin does that in Schedulinq.
• It does not let one team member belong to several organisations.
• It has no test mode. Test against a separate test organisation, never your live one; contact support@schedulinq.com to set one up.

Base URL and format

Every endpoint lives under https://api.schedulinq.com/api/v1. Requests and answers are JSON, over HTTPS only. Names are camelCase, ids are UUIDs and times are ISO 8601 with their offset. The reference lists the conventions in full.

What you receive

Answers and webhook payloads carry:

• ids, times and status;
• the service, and the team members by id and name;
• the place — for a visit at the customer's home, that is their address;
• the metadata — your own references, copied onto every appointment that follows from an invitation or planning link (see Metadata);
• on a team member, their name, e-mail address and custom fields.

They carry no customer name, e-mail address or phone number: the customer appears as a customerId. Still, treat what you receive as personal data. That includes the dashboard's webhook delivery log, which keeps request bodies for 30 days and is shown to admins.

Security model

The API's consumer is your organisation's own system: your CRM and your webhook receiver, on your servers.

• A key belongs to one organisation. Another organisation's id answers 404, as if it did not exist.
• The key is a secret. It acts for the whole organisation. Keep it on your server, never in a browser, a URL, a repository or a log line. See Authentication.
• Treat appointment and invitation ids as confidential. Store them in your own system and do not show them to customers or put them in links you send out.
• A planning link's url is a secret too: it opens once, within 15 minutes.
• Invitations your system sends say so in the dashboard: "Via API" and the key's name, on the invitation page and, for team members, on the Team page.

Frequently asked questions

Is there an SDK?

No. The API is described in OpenAPI, which most languages can turn into a client. The reference links to the description.

Can I call the API from a browser?

No. The API sends no CORS headers, and a key in browser code is a key anyone can copy. Call it from your server, and have your server send the browser on where needed — to a planning link, for example.