Birdeye Business API

openapi: 3.2.0
info:
  title: Birdeye Business API
  version: '1.0'
  description: 'Operations tagged Business 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: Business
  description: Create and maintain your business on Birdeye.
paths:
  /v1/signup/reseller/subaccount:
    post:
      summary: Create a business
      operationId: create-a-business
      tags:
      - Business
      parameters:
      - name: rid
        in: query
        required: true
        description: Id of the Reseller.
        schema:
          type: number
        example: '12334667201'
      - name: email_id
        in: query
        required: true
        description: Business Email id.
        schema:
          type: string
        example: sample@birdeye.com
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 2166
                  message: Invalid Business Type
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                businessName:
                  type: string
                zip:
                  type: string
                type:
                  type: string
                phone:
                  type: number
                entityCategory:
                  type: string
                countryCode:
                  type: string
                aggrOptions:
                  type: number
              required:
              - businessName
              - zip
              - phone
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{businessNumber}/search:
    post:
      summary: Search Business
      operationId: search-business
      tags:
      - Business
      parameters:
      - name: businessNumber
        in: path
        required: true
        description: Long id of the business, under which user wants to search for.
        schema:
          type: number
        example: '169744180007807'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 400
                  message: Page size must not be less than one!
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                searchStr:
                  type: string
                sortBy:
                  type: string
                sortOrder:
                  type: string
                startIndex:
                  type: number
                pageSize:
                  type: number
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{business_id}:
    get:
      summary: Get Business
      operationId: get-business
      tags:
      - Business
      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: 1167
                  message: API key is missing
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{businessId}:
    put:
      summary: Update Business
      operationId: update-business
      tags:
      - Business
      parameters:
      - name: businessId
        in: path
        required: true
        description: The Business Number
        schema:
          type: string
        example: '12345678'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 6001
                  message: The 'sub_locality' field cannot exceed 80 characters.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                name:
                  type: string
                alias:
                  type: string
                isAddressHidden:
                  type: number
                location:
                  type: object
                  properties:
                    address1:
                      type: string
                    address2:
                      type: string
                    subLocality:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    countryCode:
                      type: string
                    zip:
                      type: string
                  required:
                  - zip
                emailId:
                  type: string
                phone:
                  type: string
                fax:
                  type: string
                websiteUrl:
                  type: string
                establishedYear:
                  type: number
                timezone:
                  type: string
                languages:
                  type: array
                isServiceAreaProvider:
                  type: string
                serviceAreas:
                  type: array
                working24x7:
                  type: number
                hoursOfOperations:
                  type: array
                specialHours:
                  type: array
                businessStatus:
                  type: string
                reopenDate:
                  type: string
                services:
                  type: string
                keywords:
                  type: string
                products:
                  type: string
                appointmentLink:
                  type: string
                reservationLink:
                  type: string
                menuLink:
                  type: string
                orderAheadLink:
                  type: string
                impressum:
                  type: string
                payment:
                  type: string
                localPhoneNumber:
                  type: string
                tollFreePhoneNumber:
                  type: string
                androidAppURL:
                  type: string
                iosAppURL:
                  type: string
                logoUrl:
                  type: string
                gmbLogoOptOut:
                  type: number
                fbLogoOptOut:
                  type: number
                gmbCoverOptOut:
                  type: number
                fbCoverOptOut:
                  type: number
                coverImageUrl:
                  type: string
                gmbCover:
                  type: string
                facebookCover:
                  type: string
                coverBusinessInfoLayout:
                  type: string
                covidInfo:
                  type: object
                  properties:
                    postDescription:
                      type: string
                    covid19SupportLink:
                      type: string
                    virtualCareLink:
                      type: string
                bingListing:
                  type: object
                  properties:
                    primaryCategoryBing:
                      type: string
                    bingPhoneNumber:
                      type: string
                    categories:
                      type: string
                    bingDescription:
                      type: string
                internalListing:
                  type: object
                  properties:
                    description:
                      type: string
                    category:
                      type: string
                    subcategory:
                      type: string
                    displayCategory:
                      type: string
                  required:
                  - category
                  - subcategory
                facebookListing:
                  type: object
                  properties:
                    category:
                      type: string
                    facebookDescription:
                      type: string
                    facebookPhoneNumber:
                      type: string
                gmbListing:
                  type: object
                  properties:
                    googleWebsiteUrl:
                      type: string
                    googlePhoneNumber:
                      type: string
                    googleStoreId:
                      type: string
                    primaryCategoryGmb:
                      type: string
                    additionalCategory:
                      type: string
                    googleDescription:
                      type: string
                    attributes:
                      type: object
                    foodDelivery:
                      type: string
                    foodTakeout:
                      type: string
                socialProfileURLs:
                  type: object
                  properties:
                    facebookUrl:
                      type: string
                    twitterUrl:
                      type: string
                    linkedInUrl:
                      type: string
                    googleUrl:
                      type: string
                    youTubeUrl:
                      type: string
                isSEOEnabled:
                  type: boolean
                externalReferenceId:
                  type: string
                customFields:
                  type: object
                  properties:
                    type:
                      type: string
                    fieldValue:
                      type: string
                    fieldName:
                      type: string
                    id:
                      type: number
                  required:
                  - fieldName
                  - id
                entityCategory:
                  type: string
              required:
              - emailId
              - phone
              - services
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{business_Id}:
    delete:
      summary: Delete Business
      operationId: delete-business
      tags:
      - Business
      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: 1175
                  message: No business found with the given id
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{business_id}/status:
    put:
      summary: Update the status
      operationId: update-the-status
      tags:
      - Business
      parameters:
      - name: business_id
        in: path
        required: true
        description: Business id whose status has to be changed. Returned by create business API
        schema:
          type: string
        example: '12345678'
      - name: astatus
        in: query
        required: true
        description: New status for the business. Valid values are "active/inactive".
        schema:
          type: string
        example: inactive
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1191
                  message: Invalid status.
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/child/all:
    get:
      summary: Get Child Businesses
      operationId: get-child-businesses
      tags:
      - Business
      parameters:
      - name: pid
        in: query
        required: true
        description: Reseller/Sub-reseller/Enterprise Id.
        schema:
          type: number
        example: '12345678'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: array
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/tabs:
    post:
      summary: Update public profile of Businesses
      operationId: update-public-profile-of-businesses
      tags:
      - Business
      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: 1191
                  message: Invalid status.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                profileTabs:
                  type: array
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{businessId}/hierarchy:
    get:
      summary: Get hierarchy for an enterprise
      operationId: get-hierarchy-for-an-enterprise
      tags:
      - Business
      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: 1167
                  message: API key is missing
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/business-hierarchy/location/update-mapping/{businessId}:
    post:
      summary: Update Hierarchy
      operationId: update-hierarchy
      tags:
      - Business
      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: 1011
                  message: Business id is invalid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                Level:
                  type: string
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{businessNumber}/profile/customcard:
    get:
      summary: Get Custom card details
      operationId: get-custom-card-details
      tags:
      - Business
      parameters:
      - name: businessNumber
        in: path
        required: true
        description: Id of a business (Long).
        schema:
          type: number
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1011
                  message: Business id is invalid
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/public/card/{cardId}:
    put:
      summary: Update Custom card
      operationId: update-custom-card
      tags:
      - Business
      parameters:
      - name: cardId
        in: path
        required: true
        description: Id of the custom card to update.
        schema:
          type: number
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1011
                  message: Business id is invalid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                cardId:
                  type: number
                title:
                  type: string
                description:
                  type: string
                imageURL:
                  type: string
                imagePosition:
                  type: string
                isVisible:
                  type: number
                isPinOnTop:
                  type: number
                clickURL:
                  type: string
                linkText:
                  type: string
                type:
                  type: string
              required:
              - cardId
              - title
      security:
      - apiKey: []
    delete:
      summary: Delete Custom card
      operationId: delete-custom-card
      tags:
      - Business
      parameters:
      - name: cardId
        in: path
        required: true
        description: Id of the custom card to delete.
        schema:
          type: number
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1011
                  message: Business id is invalid
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{businessNumber}/timezones:
    get:
      summary: Get Timezone List
      operationId: get-timezone-list
      tags:
      - Business
      parameters:
      - name: businessNumber
        in: path
        required: true
        description: Id of a business (Long).
        schema:
          type: number
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1011
                  message: Business id is invalid
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/business/{businessNumber}/birdeye/impressions:
    post:
      summary: Get Birdeye Impressions
      operationId: get-birdeye-impressions
      tags:
      - Business
      parameters:
      - name: businessNumber
        in: path
        required: true
        description: Account Business Number.
        schema:
          type: string
        example: '169744180007807'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1167
                  message: API key is missing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                businessNumbers:
                  type: string
                startDate:
                  type: string
                endDate:
                  type: string
                limit:
                  type: number
                startIndex:
                  type: number
                sortby:
                  type: string
                order:
                  type: string
              required:
              - businessNumbers
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
components:
  schemas:
    2520Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2520
        message: Open Date is not supported for this date
    1069Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1069
        message: Business description cannot be more than 4000 characters.
    3337Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2278
        message: Primary GBP category is not allowed in additional GBP categories.
    Apiary_getChildBusinesses_Response200:
      type: array
      items:
        type: object
        properties:
          id:
            type: number
            description: Id of the Business
          name:
            type: string
            description: Name of the Business/Product (Max 1000 character long).
          alias:
            type: string
            description: Alias, Your internal way of identifying this location.
          phone:
            type: string
            description: Business Phone (Required) Format is (xxx) xxx-xxxx.
          address:
            type: object
            properties:
              address1:
                type: string
                description: Address of the business.
              address2:
                type: string
                description: Address of the business.
              subLocality:
                type: string
                description: '(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system.'
              city:
                type: string
                description: City (Max 1000 character long).
              state:
                type: string
                description: State (2 character state code).
              countryCode:
                type: string
                description: Country Code (2 character country code).
              zip:
                type: string
                description: Zip Code.
            required:
            - zip
            description: Business address
          status:
            type: string
            description: Business status. Valid values are demo, active, inactive. Default is
          type:
            type: string
            description: 'Business type. Valid values are "Business, Enterprise-Location, Enterprise-Product, Reseller or a existing custom hierarchy type". Default is:'
          createdOn:
            type: string
            description: Business singup date.
          createdBy:
            type: string
            description: Full name of the user who created the business (or location).
          childCount:
            type: number
            description: 'Child account count. note: applicable only for Reseller, Enterprise-Location, Enterprise-Product.'
    1167Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1167
        message: API key is missing
    1045Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1045
        message: Business name cannot be blank
    2151Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2151
        message: Not a valid reseller/enterprise id.
    1056Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1056
        message: Not a valid US fax number.
    1047Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1047
        message: Business name cannot be less than 3 characters
    1011Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1011
        message: Business id is invalid
    1093Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1093
        message: HierarchyNode is enabled for this account.
    1033Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1033
        message: You are not authorized to perform this action
    1150Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1150
        message: Business already associated with this reseller
    1076Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1176
        message: Business info cannot be blank
    2166Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2166
        message: Invalid Business Type
    1184Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1184
        message: Status change is not allowed
    2513Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2513
        message: Opened On date can not be in future.
    Apiary_getTimezoneList_Response200:
      type: object
      properties:
        timezones:
          type: array
          items:
            type: object
            properties:
              value:
                type: number
                description: The timezone value.
              label:
                type: string
                description: The timezone label.
    2519Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2519
        message: Third party categories change for opening soon business is not allowed.
    Apiary_searchBusiness_Response200:
      type: object
      properties:
        totalCount:
          type: number
          description: The total number of search matches.
        accounts:
          type: array
          description: Search results
          items:
            type: object
            properties:
              name:
                type: string
                description: The business name
              status:
                type: string
                description: The business status - active, demo, paid, suspended etc.
              createdAt:
                type: string
                description: The date of business (or location) creation.
              createdBy:
                type: string
                description: Full name of the user who created the business (or location).
              businessNumber:
                type: string
                description: Unique number associated with every business (or location).
              type:
                type: string
                description: Returned in case of resellers, specifies whether account is SMB, enterprise, or reseller
    1070Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1070
        message: Business keywords cannot be more than 1000 characters.
    3334Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2503
        message: Primary category can not be included in additional category.
    1010Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1010
        message: No user found with the given id
    2157Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2157
        message: Business already associated with another reseller/enterprise.
    Apiary_updateCustomCard_Request:
      type: object
      properties:
        cardId:
          type: number
          description: Id of the custom card to update.
        title:
          type: string
          description: Title shown on the custom card.
        description:
          type: string
          description: Description/content shown on the custom card.
        imageURL:
          type: string
          description: Public image URL displayed on the card.
        imagePosition:
          type: string
          description: 'Image position value. Possible values are:'
        isVisible:
          type: number
          description: 'Visibility status of card on the microsite. Possible values are:'
        isPinOnTop:
          type: number
          description: Pin status of card on the microsite.
        clickURL:
          type: string
          description: Redirect URL for card click action.
        linkText:
          type: string
          description: Text displayed for the link.
        type:
          type: string
          description: Type/category of the custom card.
      required:
      - cardId
      - title
      example:
        cardId: 14744
        title: title
        description: desc
        imageURL: https://d1py4eyp5hehj0.cloudfront.net/upload/1475208/1737886366109/Screenshot20250109040058.png
        imagePosition: '1'
        isVisible: 1
        isPinOnTop: 1
        clickURL: https://www.google.com/
        linkText: ''
        type: Link type
    2150Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2150
        message: Not a valid reseller/enterprise id.
    2518Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2518
        message: Business Status is mandatory to pass with reopen, opened on and opening soon date.
    2286Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 2286
        message: Zip code is not provided for business
    1052Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1052
        message: User email id cannot be blank
    2517Model:
      type: object
      properties:
        code:
          type: number

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