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

POST /v1/customer-v2/external/saveCustomer Create or Update Contact #
POST /v1/customer-v2/external/getCustomer Get Contact #
POST /v1/customer-v2/external/deleteCustomer Delete Contact #
POST /v1/customer/checkin Customer Checkin #
GET /v1/customer/history/{customerId} Customer activity log #
DELETE /v1/customer/id/{customerId} Customer Delete #
POST /v1/customer-v2/change-permission Subscribe/Unsubscribe Customer #
POST /v2/customer/list Contact #
POST /v1/contact/details Customer or Lead list #
POST /v1/contactUs/{businessId} Contact Us Request #
POST /v1/contact/{businessId}/update-feed Get opt-out contact data #

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-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