OpenPhone

# OpenPhone Docs

## Docs

- [Authentication](https://openphone.mintlify.dev/docs/mdx/api-reference/authentication.md): Learn how to gain API access.
- [Get a call by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/calls/get-a-call-by-id.md): Get a call by its unique identifier.
- [Get a summary for a call](https://openphone.mintlify.dev/docs/mdx/api-reference/calls/get-a-summary-for-a-call.md): Retrieve a detailed summary of a specific call identified by its unique call ID. This endpoint supports summaries for both regular calls and calls handled by Sona. Call summaries are only available on business and scale plans.
- [Get a transcription for a call](https://openphone.mintlify.dev/docs/mdx/api-reference/calls/get-a-transcription-for-a-call.md): Retrieve a detailed transcript of a specific call identified by its unique call ID. This endpoint supports transcripts for both regular calls and calls handled by Sona. Call transcripts are only available on business and scale plans.
- [Get a voicemail for a call](https://openphone.mintlify.dev/docs/mdx/api-reference/calls/get-a-voicemail-for-a-call.md): Retrieve a voicemail associated with a specific call. Returns null data fields while the voicemail is processing in our system. Returns competed data fields when the voicemail has finished processing.
- [Get recordings for a call](https://openphone.mintlify.dev/docs/mdx/api-reference/calls/get-recordings-for-a-call.md): 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.
- [List calls](https://openphone.mintlify.dev/docs/mdx/api-reference/calls/list-calls.md): Fetch a paginated list of calls associated with a specific OpenPhone number and another number.
- [Changelog](https://openphone.mintlify.dev/docs/mdx/api-reference/changelog.md): Stay up to date with the latest improvements to the API.
- [Get contact custom fields](https://openphone.mintlify.dev/docs/mdx/api-reference/contact-custom-fields/get-contact-custom-fields.md): 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.
- [Create a contact](https://openphone.mintlify.dev/docs/mdx/api-reference/contacts/create-a-contact.md): Create a contact for a workspace.
- [Delete a contact](https://openphone.mintlify.dev/docs/mdx/api-reference/contacts/delete-a-contact.md): Delete a contact by its unique identifier.
- [Get a contact by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/contacts/get-a-contact-by-id.md): Retrieve detailed information about a specific contact in your OpenPhone workspace using the contact's unique identifier.
- [List contacts](https://openphone.mintlify.dev/docs/mdx/api-reference/contacts/list-contacts.md): Retrieve a paginated list of contacts. You can optionally filter the results by providing external IDs and sources. When no external IDs are provided, all contacts for the organization are returned.
- [Update a contact by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/contacts/update-a-contact-by-id.md): Modify an existing contact in your OpenPhone workspace using the contact's unique identifier.
- [List Conversations](https://openphone.mintlify.dev/docs/mdx/api-reference/conversations/list-conversations.md): Fetch a paginated list of conversations of OpenPhone conversations. Can be filtered by user and/or phone numbers. Defaults to all conversations in the OpenPhone organization. Results are returned in descending order based on the most recent conversation.
- [API response codes](https://openphone.mintlify.dev/docs/mdx/api-reference/error-codes.md): Quo uses standard HTTP response codes to indicate request status. 
- [Introduction](https://openphone.mintlify.dev/docs/mdx/api-reference/introduction.md): Welcome to the Quo API!
- [Get a message by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/messages/get-a-message-by-id.md): Get a message by its unique identifier.
- [List messages](https://openphone.mintlify.dev/docs/mdx/api-reference/messages/list-messages.md): Retrieve a chronological list of messages exchanged between your OpenPhone number and specified participants, with support for filtering and pagination. 
- [Send a text message](https://openphone.mintlify.dev/docs/mdx/api-reference/messages/send-a-text-message.md): Send a text message from your OpenPhone number to a recipient.
- [Partner directory](https://openphone.mintlify.dev/docs/mdx/api-reference/partner-directory.md): Connect with experts to achieve your customer communications goals.
- [Get a phone number by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/phone-numbers/get-a-phone-number-by-id.md): Get a phone number by its unique identifier.
- [List phone numbers](https://openphone.mintlify.dev/docs/mdx/api-reference/phone-numbers/list-phone-numbers.md): Retrieve the list of phone numbers and users associated with your OpenPhone workspace.
- [Rate limits](https://openphone.mintlify.dev/docs/mdx/api-reference/rate-limits.md): Quo implements rate limiting to ensure API stability and fair usage.
- [Send your first message](https://openphone.mintlify.dev/docs/mdx/api-reference/send-your-first-message.md): This is a step-by-step guide for sending your first text message.
- [Technology partners](https://openphone.mintlify.dev/docs/mdx/api-reference/tech-partner.md): Integrate Quo to give your app powerful communication and AI features.
- [Get a user by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/users/get-a-user-by-id.md): Retrieve detailed information about a specific user in your OpenPhone workspace using the user's unique identifier.
- [List users](https://openphone.mintlify.dev/docs/mdx/api-reference/users/list-users.md): Retrieve a paginated list of users in your OpenPhone workspace.
- [Create a new webhook for call summaries](https://openphone.mintlify.dev/docs/mdx/api-reference/webhooks/create-a-new-webhook-for-call-summaries.md): Creates a new webhook that triggers on events from call summaries.
- [Create a new webhook for call transcripts](https://openphone.mintlify.dev/docs/mdx/api-reference/webhooks/create-a-new-webhook-for-call-transcripts.md): Creates a new webhook that triggers on events from call transcripts.
- [Create a new webhook for calls](https://openphone.mintlify.dev/docs/mdx/api-reference/webhooks/create-a-new-webhook-for-calls.md): Creates a new webhook that triggers on events from calls.
- [Create a new webhook for messages](https://openphone.mintlify.dev/docs/mdx/api-reference/webhooks/create-a-new-webhook-for-messages.md): Creates a new webhook that triggers on events from messages.
- [Delete a webhook by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/webhooks/delete-a-webhook-by-id.md): Delete a webhook by its unique identifier.
- [Get a webhook by ID](https://openphone.mintlify.dev/docs/mdx/api-reference/webhooks/get-a-webhook-by-id.md): Get a webhook by its unique identifier.
- [Lists all webhooks](https://openphone.mintlify.dev/docs/mdx/api-reference/webhooks/lists-all-webhooks.md): List all webhooks for a user.
- [Building with AI LLMs](https://openphone.mintlify.dev/docs/mdx/guides/building-with-ai-llms.md): Learn how to use AI Language Models to build applications with the Quo API.
- [Integration contacts](https://openphone.mintlify.dev/docs/mdx/guides/contacts.md): Learn more about working with contacts via the Quo API.
- [Sync your contacts](https://openphone.mintlify.dev/docs/mdx/guides/sync-contacts.md): Implement a one-way contact sync from Google Sheets to Quo using Javascript.
- [Webhooks](https://openphone.mintlify.dev/docs/mdx/guides/webhooks.md): A reference for API-generated webhook payloads.
- [Contact the team](https://openphone.mintlify.dev/docs/mdx/pricing-support/contact-the-team.md): Stuck? Need Help?
- [Tips for minimizing costs](https://openphone.mintlify.dev/docs/mdx/pricing-support/minimizing-costs.md): We’ve provided the below tips to help you minimize segment counts and save money.
- [API Pricing overview](https://openphone.mintlify.dev/docs/mdx/pricing-support/pricing-overview.md): Welcome to Quo's simple and transparent API pricing structure.
- [Terms of Service](https://openphone.mintlify.dev/docs/mdx/pricing-support/terms-of-service.md): Developer API Terms of Service


## Optional

- [OpenAPI download](https://openphone-public-api-prod.s3.us-west-2.amazonaws.com/public/openphone-public-api-v1-prod.json)