Birdeye

Birdeye Aggregation API

Access your public data from 150+ review sites.

Documentation GitHub OpenAPI

Operations 4

GET /v1/aggregation/business/{businessId} Get all aggregation source #

GET /v1/survey/reviewsites-alias Get all aggregation source #

POST /v1/aggregation/business/{business_id} Add aggregation URL #

DELETE /v1/aggregation/business/{businessID}/aggregation/{aggregationID} Delete aggregation URL #

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-aggregation-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 email required.

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 Aggregation API
  version: '1.0'
  description: 'Operations tagged Aggregation 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: Aggregation
  description: Access your public data from 150+ review sites.
paths:
  /v1/aggregation/business/{businessId}:
    get:
      summary: Get all aggregation source
      operationId: get-all-aggregation-source
      tags:
      - Aggregation
      parameters:
      - name: businessId
        in: path
        required: true
        description: Id of the Business.
        schema:
          type: string
        example: '12345678'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1175
                  message: No business found with the given id
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/survey/reviewsites-alias:
    get:
      summary: Get all aggregation source
      operationId: get-all-aggregation-source
      tags:
      - Aggregation
      parameters:
      - name: businessId
        in: query
        required: true
        description: Id of the business.
        schema:
          type: string
        example: '12345678'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1175
                  message: No business found with the given id
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/aggregation/business/{business_id}:
    post:
      summary: Add aggregation URL
      operationId: add-aggregation-url
      tags:
      - Aggregation
      parameters:
      - name: business_id
        in: path
        required: true
        description: Id of the business.
        schema:
          type: string
        example: '12345678'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1032
                  message: Invalid source id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                sourceAlias:
                  type: string
                url:
                  type: string
              required:
              - sourceAlias
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/aggregation/business/{businessID}/aggregation/{aggregationID}:
    delete:
      summary: Delete aggregation URL
      operationId: delete-aggregation-url
      tags:
      - Aggregation
      parameters:
      - name: businessID
        in: path
        required: true
        description: Id of the business.
        schema:
          type: string
        example: '12345678'
      - name: aggregationID
        in: path
        required: true
        description: Id of the aggregation to be deleted.
        schema:
          type: number
        example: abcdefgh
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1039
                  message: Invalid business aggregation id
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
components:
  schemas:
    Apiary_addNewCompetitorAggregationUrl_Request:
      type: object
      properties:
        sourceAlias:
          type: string
          description: Source alias.
        url:
          type: string
          description: Source url to be added.
      required:
      - sourceAlias
      - url
      example:
        sourceAlias: 'citysearch '
        url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco
    1167Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1167
        message: API key is missing
    1032Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1032
        message: Invalid source id
    1031Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1031
        message: Source id cannot be blank
    1011Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1011
        message: Business id is invalid
    1033Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1033
        message: You are not authorized to perform this action
    1175Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1175
        message: No business found with the given id
    Apiary_addAggregationUrl_Response200:
      type: object
      properties:
        id:
          type: number
          description: Id of the created Aggregation.
        sourceAlias:
          type: string
          description: Alias of the source.
        sourceName:
          type: string
          description: Name of the source.
        sourceUrl:
          type: string
          description: Url of the souce.
        Body:
          type: string
          description: "{\n    \"id\": \"237030543\",\n    \"sourceAlias\": \"citysearch\",\n    \"sourceName\": \"Citysearch\",\n    \"sourceUrl\": \"http://www.citysearch.com/biz/maria-da-vittorio-san-francisco\"\n}"
    1039Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1039
        message: Invalid business aggregation id
    1161Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1161
        message: Invalid API key
    1030Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1030
        message: URL cannot be blank
    Apiary_getAllAggregationSource_Response200:
      type: array
      items:
        type: object
        properties:
          id:
            type: number
            description: Id of aggregation.
          sourceAlias:
            type: string
            description: Source alias.
          sourceUrl:
            type: string
            description: Source url.
          sourceName:
            type: string
            description: Source name.
          status:
            type: number
            description: 'This field indicates the status of aggregation:'
    89Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 89
        message: Rate limit exceeded
  requestBodies:
    Add_aggregation_URLBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Apiary_addNewCompetitorAggregationUrl_Request'
  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