@font-face {
  font-family: "Roobert";
  src: url("https://uploads-ssl.webflow.com/6384fdd9fd42380b529fc942/646dce023a43d52740e2f3c8_Roobert-SemiBold.ttf");
  font-weight: 600;
  font-style: normal;
}

@font-face {
  font-family: "Roobert";
  src: url("https://uploads-ssl.webflow.com/6384fdd9fd42380b529fc942/646dce02a844c04f2faca171_Roobert-Medium.ttf");
  font-weight: 500;
  font-style: normal;
}

h1,
h2,
h3 {
  font-family: "Roobert", sans-serif;
}

strong {
  color: inherit !important;
}

#topbar-cta-button {
  height: 36px;
}

#topbar-cta-button > a > span {
  background-color: #6439f5;
  border-radius: 10px;
}

#topbar-cta-button > a > div span,
#topbar-cta-button > a > div svg {
  color: white;
}


Overview

Key features

Next steps

API reference

Development resources

Pricing & support

OpenAPI download

OpenPhone Docs

Try for free

Feedback

Log in

Introduction

Authentication

This is a step-by-step guide for sending your first text message.

Send your first message

Connect with experts to achieve your customer communications goals.

OpenPhone partner directory

OpenPhone uses standard HTTP response codes to indicate request status. 

API response codes

Stay up to date with the latest improvements to the API.

Changelog

OpenPhone implements rate limiting to ensure API stability and fair usage.

Rate limits

Welcome to OpenPhone's simple and transparent API pricing structure.

Pricing overview

We’ve provided the below tips to help you minimize segment counts and save money.

Tips for minimizing costs

Contact the team

Terms of Service

Learn more about working with contacts via the OpenPhone API.

Integration contacts

A reference for API-generated webhook payloads.

Webhooks

Learn how to use AI Language Models to build applications with the OpenPhone API.

Building with AI LLMs

Implement a one-way contact sync from Google Sheets to OpenPhone using Javascript.

Sync your contacts

Fetch a paginated list of calls associated with a specific OpenPhone number and another number.

List calls

Retrieve a list of recordings associated with a specific call. The results are sorted chronologically, with the oldest recording segment appearing first in the list.

Get recordings for a call

Retrieve an AI-generated summary of a specific call identified by its unique call ID. Call summaries are only available on OpenPhone Business plan.

Get a summary for a call

Retrieve a detailed transcript of a specific call identified by its unique call ID. Call transcripts are only available on OpenPhone business plan.

Get a transcription for a call

Custom contact fields enhance your OpenPhone contacts with additional information beyond standard details like name, company, role, emails and phone numbers. These user-defined fields let you capture business-specific data. While you can only create or modify these fields in OpenPhone itself, this endpoint retrieves your existing custom properties. Use this information to accurately map and include important custom data when creating new contacts via the API.

Get contact custom fields

Fetch a paginated list of contacts associated with specific external IDs. Optionally narrow the results further by supplying a list of sources. While we do intend to offer a true "list all contacts" endpoint in the future, the `externalIds` parameter is currently **required** to narrow the result set to only the desired contacts, if they exist.

List contacts by externalIds and sources

Create a contact

Retrieve detailed information about a specific contact in your OpenPhone workspace using the contact's unique identifier.

Get a contact by ID

Delete a contact by its unique identifier.

Delete a contact

Modify an existing contact in your OpenPhone workspace using the contact's unique identifier.

Update a contact by ID

Fetch a paginated list of conversations for a specific OpenPhone number. Results are returned in descending order based on the most recent conversation.

List Conversations

Retrieve a chronological list of messages exchanged between your OpenPhone number and specified participants, with support for filtering and pagination. 

List messages

Send a text message from your OpenPhone number to a recipient.

Send a text message

Get a message by ID

Retrieve the list of phone numbers and users associated with your OpenPhone workspace.

Getting started

Essentials

Calls

Contact Custom Fields

Contacts

Conversations

Messages

Phone Numbers

Webhooks

Introduction

Overview

Key features

REST architecture

Secure authentication

JSON responses

Developer tools

Next steps

Getting started

Essentials

Calls

Contact Custom Fields

Contacts

Conversations

Messages

Phone Numbers

Webhooks

​Overview

​Key features

REST architecture

Secure authentication

JSON responses

Developer tools

​Next steps

Overview

Key features

Next steps