Birdeye

Birdeye Campaign API

Create a short link for review requests and set review sources in the template.

Documentation GitHub OpenAPI

Operations 2

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/campaign/external/campaign-request-url Get a review request link for a customer · Fetch Request URL #

Ask an LLM

“Can I generate a review request link for a specific customer?”

“Can the request link point to a survey or a specific template?”

Tell an agent

Fetch the review request URL for customer {customerId} at business {businessId}.

Get a survey request link for customer {customerId} using survey {surveyId} at business {businessId}.

POST /v1/campaign/external/default-review-sources Apply default review sources to a customer · Set Defaullt Review Sources #

Ask an LLM

“Can I set the default review sources a customer is asked to review on?”

“Is it possible to reset a customer's review sources back to the business defaults?”

Tell an agent

Set default review sources for customer {customerId} at business {businessId}.

Apply the business default review sites to customer {customerId} in {businessId}.

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

openapi: 3.2.0
info:
  title: Birdeye Campaign API
  version: '1.0'
  description: 'Operations tagged Campaign 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:
- name: Campaign
  description: Create a short link for review requests and set review sources in the template.
paths:
  /v1/campaign/external/campaign-request-url:
    post:
      summary: Fetch Request URL
      operationId: fetch-request-url
      tags:
      - Campaign
      parameters: []
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 89
                  message: Rate limit exceeded
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                businessId:
                  type: number
                customerId:
                  type: number
                surveyId:
                  type: number
                templateId:
                  type: number
                checkinId:
                  type: number
              required:
              - businessId
              - customerId
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/campaign/external/default-review-sources:
    post:
      summary: Set Defaullt Review Sources
      operationId: set-defaullt-review-sources
      tags:
      - Campaign
      parameters: []
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 89
                  message: Rate limit exceeded
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                businessId:
                  type: number
                customerId:
                  type: array
              required:
              - businessId
              - customerId
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
components:
  schemas:
    1040Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1040
        message: Invalid temmplate id.
    89Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 89
        message: Rate limit exceeded
    1011Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1011
        message: Business id is invalid
    1161Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1161
        message: Invalid API key
    1315Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1315
        message: Invalid survey.
    1089Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1089
        message: Customer id is invalid.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Partner specific API key provided by Birdeye for data exchange.
x-refined-from:
- birdeye-birdeye-api-openapi.yml
- birdeye-openapi-original.yml