Skip to content
Remute

Build on Remute with the REST API

Read calls, create and update appointments and contacts, and check availability from your own software.

What it does

The REST API gives your own code access to the data in your Remute workspace. List and read calls, create and update contacts and appointments, check free times and manage webhooks.

Requests authenticate with an API key, and the OpenAPI document describes every endpoint so you can generate a client.

GET /api/v1/calls200
  • 200 OK5 calls returned
  • AuthorizationBearer rk_live_••••
  • Limit60 per minute

OpenAPI included

Use cases

  • Sync with your own system

    Pull calls and contacts into an internal tool or data warehouse on a schedule.

  • Book from your website

    Check availability and create an appointment from a booking form, so the phone and the site share one calendar.

  • Custom reporting

    Build the dashboard your team wants from the same data the panel uses.

How to get started

Create a key on the Developers page. Keys are shown once and stored hashed.

  1. In Remute, open Developers in the sidebar.
  2. Create an API key. It starts with rk_live_. Copy it now, it is shown once.
  3. Send it as a Bearer token. For example, list your latest calls with a GET request to /api/v1/calls.
  4. Open /api/v1/openapi.json to see every endpoint and generate a client.
  5. Keep the key out of public code. Revoke and replace it if it leaks.
DevelopersKeys
  • API keys1 active
  • Webhooks2 endpoints
  • Calendar feedPrivate .ics link

Shown once, stored hashed

Endpoints

A small, predictable surface. The full list is in the OpenAPI document.

EndpointWhat it doesMethods
/callsList and read callsGET
/appointmentsList, read, create and update appointmentsGET, POST, PATCH
/contactsList, read, create and update contactsGET, POST, PATCH
/availabilityFree times for a dateGET
/webhooksRegister and manage webhooksGET, POST, DELETE

Good to know

  • The API needs the Pro or Business plan.
  • Each key can make 60 requests per minute. Over the limit you get a 429 with a Retry-After of 60 seconds.
  • Writes through the API are recorded in the audit log.

Frequently asked questions

Is there an OpenAPI specification?

Yes, at /api/v1/openapi.json. Use it to browse the endpoints or generate a client.

What are the rate limits?

60 requests per minute per key. Past that, you get a 429 with a Retry-After header.

Can I create appointments through the API?

Yes. You can create and update appointments and contacts, and check availability first.

Put your next call to work

Start free