Engage each customer at the right time with NPS or CSAT surveys to improve your service.
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
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/birdeye:birdeye-survey-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Birdeye Survey API
version: '1.0'
description: 'Operations tagged Survey 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: Survey
description: Engage each customer at the right time with NPS or CSAT surveys to improve your service.
paths:
/v1/survey/{survey_id}:
get:
summary: Get Survey
operationId: get-survey
tags:
- Survey
parameters:
- name: survey_id
in: path
required: true
description: Id of the Survey.
schema:
type: integer
example: '123'
- name: businessId
in: query
required: true
description: Id of the Business.
schema:
type: number
example: '12345678'
- name: lang
in: query
required: false
description: The survey locale, default is english
schema:
type: string
example: english
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 89
message: Rate limit exceeded
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/survey/{survey_id}/submit:
post:
summary: Post a survey response
operationId: post-a-survey-response
tags:
- Survey
parameters:
- name: survey_id
in: path
required: true
description: Id of the Survey.
schema:
type: integer
example: '123'
- 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: 1011
message: Business id is invalid
requestBody:
required: true
content:
application/json:
schema:
type: object
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/survey/ext/list/responses/{survey_id}:
post:
summary: List Responses for a Survey
operationId: list-responses-for-a-survey
tags:
- Survey
parameters:
- name: survey_id
in: path
required: true
description: Id of the Survey.
schema:
type: integer
example: '123'
- name: businessNumber
in: query
required: true
description: The Business Number of Enterprise
schema:
type: string
example: '169744180007807'
- name: page
in: query
required: false
description: The page number, starts with 0.
schema:
type: integer
example: '0'
- name: size
in: query
required: false
description: The size of the page.
schema:
type: integer
example: '30'
- name: sortby
in: query
required: false
description: The sort by parameter.
schema:
type: string
example: date
- name: sorder
in: query
required: false
description: The sort order parameter.
schema:
type: string
example: asc
- name: includeTicketId
in: query
required: false
description: The field to fetch ticketIds associated with the response.
schema:
type: boolean
example: 'false'
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:
startDate:
type: string
endDate:
type: string
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/survey/business/{business_id}/all:
get:
summary: Get All Surveys
operationId: get-all-surveys
tags:
- Survey
parameters:
- name: sortby
in: query
required: false
description: Sort results by lastModified[modified], Created[created], Response Count[response].
schema:
type: string
example: modified
- name: sorder
in: query
required: false
description: Sort order ascending (0) and descending (1).
schema:
type: string
example: '0'
- name: searchStr
in: query
required: false
description: Search survey by name or business location.
schema:
type: string
example: abc
- name: business_id
in: path
required: true
description: Business ID.
schema:
type: string
example: '12345678'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 89
message: Rate limit exceeded
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/survey/external/create/{businessId}:
post:
summary: Create Survey
operationId: create-survey
tags:
- Survey
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: 2095
message: ownerEmailId cannot be null
requestBody:
required: true
content:
application/json:
schema:
type: object
example:
surveyName: Experience Survey
thankYouMessage: Thank you for taking the survey!
surveyType: traditional
ownerEmailId: testmail@gmail.com
pages:
- questions:
- title: Text1
type: text
- title: Paragraph
type: textarea
- title: Page 2-optional
questions:
- title: Questionnumber1
type: checkbox
required: true
choices:
- Choice 1
- Choice 2
- Choice 3
- title: Q2
type: dropdown
choices:
- Dropdown 1
- Dropdown 2
- Dropdown 3
- title: ratingQn
type: rating
minLabel: Strongly Disagree
maxLabel: Strongly Agree
maxValue: 10
- questions:
- title: P3-Q1-Radio
type: radio
choices:
- radio 1
- radio 2
- radio 3
- title: npsQn
type: nps
minLabel: Strongly Disagree
- questions:
- title: Datetime question
type: datetime
required: true
showTime: true
showDate: true
interval: 60
minValue: '12'
maxValue: '36'
- title: Please enter your contact information
type: contact
required: true
contactRows:
- required: true
title: First name
type: text
- required: true
title: Email
type: email
- required: true
title: Phone
type: phone
- title: Page 4
questions:
- title: P4-Q1
type: matrixrating
minLabel: Strongly Disagree
maxLabel: Strongly Agree
maxValue: 5
rows:
- Row label 1
- Row label 2
- title: P4-Q2
type: matrixradio
required: true
choices:
- c1
- c2
- c3
rows:
- Row 1
- Row2
- title: p4-Q3
type: matrixdropdown
required: true
choices:
- c1
- c2
- c3
rows:
- Row label 1
- Row label 2
- title: Label type ques
type: label
- questions:
- title: please review us on one of these sites
type: review
required: true
contactUsMessage: ContactUs test message
reviewSources:
- Google
- Facebook
- CitySearch
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/survey/{surveyId}/settings/update:
post:
summary: Update Survey Settings
operationId: update-survey-settings
tags:
- Survey
parameters:
- name: surveyId
in: path
required: true
description: Survey ID
schema:
type: integer
example: '123'
- 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: 2096
message: Detected conflicting user-access request!
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
surveySettings:
type: object
properties:
showSurveyTitle:
type: boolean
showQuestionNumber:
type: boolean
showProgressBar:
type: boolean
progressbarPosition:
type: string
showLogo:
type: string
showTitle:
type: string
customTitle:
type: string
themeColor:
type: string
themeTextColor:
type: string
subject:
type: string
message:
type: string
signature:
type: string
enableThankyouEmail:
type: boolean
accessControl:
type: object
properties:
userAccessList:
type: array
surveyAccess:
type: object
properties:
role:
type: string
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
components:
schemas:
2066Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2066
message: BusinessIds passed in the location type question are invalid
2048Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2048
message: Field Rows Missing
2076Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2076
message: Value of the logic is not present in the choices of Question
2093Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2093
message: Survey Field Type passed is unknown
2071Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2071
message: Invalid ownerEmailId
2037Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2037
message: The survey doesn't belong to the account.
1175Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1175
message: No business found with the given id
2096Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2096
message: Detected conflicting user-access request!
2051Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2051
message: More than one review question cannot be present
2039Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2039
message: User email is missing in user access request!
2061Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2061
message: Pickone type of survey can only contain pickone type questions
2084Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2084
message: Opeartor must be present for logics other than the first display logic
2057Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2057
message: Either one of Min and Max values is missing in datetime type question
2068Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2068
message: The locationIds are Non-Parseable
2060Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2060
message: reviewSources are not present for review type question
2040Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2040
message: Invalid value of progress bar position, expected Bottom or Top
2092Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2092
message: Invalid Logic!
2043Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2043
message: Invalid value of showTitle, accepted values are CUSTOM, LOCATION, OFF
2080Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2080
message: Display Logic Invalid!
Apiary_updateSurveySettings_Request:
type: object
properties:
surveySettings:
type: object
properties:
showSurveyTitle:
type: boolean
description: Pass true if want to show survey title.
showQuestionNumber:
type: boolean
description: Pass true if want to show question number.
showProgressBar:
type: boolean
description: Pass true if want to show progress bar.
progressbarPosition:
type: string
description: Position of progress bar.
showLogo:
type: string
description: Pass ON if want to show logo.
showTitle:
type: string
description: Show title.
customTitle:
type: string
description: Custom title value.
themeColor:
type: string
description: Theme color value.
themeTextColor:
type: string
description: Theme color text value.
subject:
type: string
description: Subject of the survey email.
message:
type: string
description: Thank you message..
signature:
type: string
description: Signature.
enableThankyouEmail:
type: boolean
description: Pass true if want to enable Thank you email.
description: Survey settings
accessControl:
type: object
properties:
userAccessList:
type: array
items:
type: object
properties:
userEmail:
type: string
description: Email of the user.
role:
type: string
description: User role.
delete:
type: boolean
description: Delete status of the user.
surveyAccess:
type: object
properties:
role:
type: string
description: User's survey access.
description: Access control data.
example:
surveySettings:
showSurveyTitle: false
showQuestionNumber: false
showProgressBar: false
progressbarPosition: Bottom
showLogo: true
showTitle: CUSTOM
customTitle: Welcome to Tennessee!
themeColor: '#1976d2'
themeTextColor: '#ffffff'
subject: Thank you for taking the survey
message: 'Hi ,
Thank you for taking the time to give your inputs on the survey.'
signature: 'Sincerely,
BMW_Survey
'
enableThankyouEmail: true
accessControl:
userAccessList:
- userEmail: abc@test.com
role: viewer
- userEmail: def@test.com
delete: true
surveyAccess:
role: editor
Apiary_getAllSurveys_Response200:
type: array
items:
type: object
properties:
surveyId:
type: number
description: Survey Id.
name:
type: string
description: Survey Name.
status:
type: string
description: Survey status.
created:
type: number
description: Survey created date in epoc.
lastModified:
type: number
description: Survey last modified date in epoc
responses:
type: number
description: Number of survey responses.
questionCount:
type: number
description: Number of questions.
2041Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2041
message: Can't modify owner or existing owner's access!
2081Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2081
message: Skip Logic Invalid!
2070Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2070
message: Question Type cannot be blank
2090Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2090
message: Invalid value of showLogo, accepted values are ON, OFF
1161Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1161
message: Invalid API key
2049Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2049
message: Interval can only be 30 min or 60 min
2065Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2065
message: There cannot be more than 3 sourceIds for review question
2058Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2058
message: LocationIds are not present
2085Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2085
message: Condition cannot be null!
2072Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2072
message: Choice cannot be a blank string
2091Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2091
message: Operator Invalid
2052Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2052
message: Review question should be present in the last page of the survey as a single question
2094Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2094
message: ReviewSources passed are invalid
2088Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2088
message: Review Source already present
2069Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2069
message: surveyName is Mandatory
2050Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2050
message: More than one location question cannot be present
2054Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2054
message: Min Value out of range
2064Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2064
message: First page of the survey must contain atleast one question except review question
2087Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2087
message: Duplicate contact sub type question is present
2045Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2045
message: Invalid Survey Type
2056Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2056
message: Min and Max values can only be even numbers when the interval is 60 minutes
2095Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2095
message: ownerEmailId cannot be null
1315Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1315
message: Invalid survey.
2038Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2038
message: Invalid value of role, expected editor, viewer or no-access
2046Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2046
message: Min Value is greater then Max Value
2062Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2062
message: Traditional type survey cannot contain these type questions
2074Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2074
message: Cannot contain a logic
2053Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2053
message: Contact Fields are not present
2082Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2082
message: The API returned an empty response.
2044Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2044
message: Survey already completed
2086Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2086
message: Question Number cannot be null
2083Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2083
message: Source is not integrated with the business
2077Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2077
message: Value of a questionLogic field cannot be blank
1167Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1167
message: API key is missing
2047Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2047
message: Survey Fields Missing!
89Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 89
message: Rate limit exceeded
2063Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2063
message: Pulse(NPS) Survey can only contain radio, text, textarea(paragraph), rating and nps type questions
2073Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2073
message: Logic type is Invalid!
1011Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1011
message: Business id is invalid
2079Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2079
message: Only one Skip logic is allowed for text and textarea type questions
2067Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2067
message: One of the locations passed in the request is not present
2042Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2042
message: Received no valid inputs in request body!
2055Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2055
message: Max Value out of range
1380Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1380
message: Api key or session token missing
2059Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 2059
message: Invalid type of contact question
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