Birdeye

Birdeye Contact API

Manage contacts across locations effortlessly with a robust Contact Management System.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/customer-v2/external/saveCustomer Create or update a contact · Create or Update Contact #
Ask an LLM
“Can I add a new contact or update an existing one in a single call?”
“Can I set a contact's SMS and email opt-in when saving them?”
Tell an agent
Save contact {firstName} {lastName} with email {email} to business {businessId}.
Update contact {id} in business {businessId} with phone {phone}.
POST /v1/customer-v2/external/getCustomer Look up a contact · Get Contact #
Ask an LLM
“Can I look up a contact by email or phone number?”
“Does fetching a contact also return their experience score?”
Tell an agent
Find the contact with email {email} in business {businessId}.
Get contact {id} from business {businessId}.
POST /v1/customer-v2/external/deleteCustomer Delete a contact from locations · Delete Contact #
Ask an LLM
“Can I delete a contact from one or more locations?”
“Is it possible to remove a contact from only some of my businesses?”
Tell an agent destructive · confirm first
Delete contact {id} from business {businessId}.
Remove contact {id} from locations {businessIds} under {businessId}.
POST /v1/customer/checkin Record a customer check-in · Customer Checkin #
Ask an LLM
“Can I record a customer check-in at a location with their name and phone?”
“Can a check-in credit the employees who served the customer?”
Tell an agent
Check in customer {name} with phone {phone} at business {bid}.
Record a check-in for {emailId} at business {bid} served by {employees}.
GET /v1/customer/history/{customerId} Get a customer's activity history · Customer activity log #
Ask an LLM
“Can I see a customer's activity history for a date range?”
“Where can I find everything logged against one customer?”
Tell an agent
Get the activity log for customer {customerId} in business {businessId}.
Show customer {customerId}'s history in {businessId} from {startDate} to {endDate}.
DELETE /v1/customer/id/{customerId} Delete an enterprise customer by ID · Customer Delete #
Ask an LLM
“Can I delete an enterprise customer record by its customer ID?”
“Is there a single call to erase a customer using only the customer ID?”
Tell an agent destructive · confirm first
Delete customer {customerId}.
Erase enterprise customer record {customerId}.
POST /v1/customer-v2/change-permission Subscribe or unsubscribe a customer · Subscribe/Unsubscribe Customer #
Ask an LLM
“Can I unsubscribe a customer from messages by email or phone?”
“Can I re-subscribe a customer who opted out?”
Tell an agent
Set permission {permission} for {email} on account {accountNumber}.
Change messaging permission for phone {phone} on account {accountNumber} to {permission}.
POST /v2/customer/list List a business's contacts · Contact #
Ask an LLM
“Can I page through all contacts of a business sorted my way?”
“Can I list contacts added within a date range?”
Tell an agent
List contacts for business {businessId}, page {page} of size {size}, sorted by {sortby}.
Get contacts for {businessId} between {startDate} and {endDate}, page {page}, size {size}, sort {sortby}.
POST /v1/contact/details List customers or leads for a period · Customer or Lead list #
Ask an LLM
“Can I pull only leads rather than customers for a date range?”
“Can the customer or lead list include tags and custom field values?”
Tell an agent
List {contactType} records for business {businessId} from {startDateUtc} to {endDateUtc}, page {page}, size {size}.
Get leads with their tags for business {businessId} between {startDateUtc} and {endDateUtc}.
POST /v1/contactUs/{businessId} Submit a contact-us request · Contact Us Request #
Ask an LLM
“Can I submit a contact-us inquiry to a business on behalf of a customer?”
“Can a website form's message be sent into Birdeye as a contact request?”
Tell an agent
Send a contact-us request from {customer} to business {businessId}.
Submit contact-us comment {customerComment} from {customer} to {businessId}.
POST /v1/contact/{businessId}/update-feed Get a location's opt-out contact feed · Get opt-out contact data #
Ask an LLM
“Which contacts unsubscribed from a business during a period?”
“Can I get a feed of subscription status changes for one location?”
Tell an agent
Get contacts with status {subscriptionStatus} for business {businessId} from {start} to {end}.
Show opt-out changes for {businessId} between {start} and {end}, status {subscriptionStatus}.

Documentation

📖
Documentation
https://docs.birdeye.com/api/introduction
📖
Authentication
https://docs.birdeye.com/api/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-contact-api-openapi.yml

Other Resources

🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/vocabulary/birdeye-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/json-ld/birdeye-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/birdeye:birdeye-contact-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

birdeye-contact-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Birdeye Contact API
  version: '1.0'
  description: 'Operations tagged Contact across 2 of this provider''s published API definitions: birdeye-birdeye-api-openapi.yml, birdeye-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.birdeye.com
  description: Production
- url: https://api.birdeye.com/resources
tags:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-contact-api-openapi.yml