Create, delete , update , associate and get custom fields easily.
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-custom-fields-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Birdeye Custom Fields API
version: '1.0'
description: 'Operations tagged Custom Fields 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: Custom Fields
description: Create, delete , update , associate and get custom fields easily.
paths:
/v1/business/public/custom-fields/create:
post:
summary: Create
operationId: create
tags:
- Custom Fields
parameters: []
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 5040
message: Max limit reached for custom fields.
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
defaultValue:
type: string
dropDownOptions:
type: array
fieldDescription:
type: string
fieldName:
type: string
filterable:
type: boolean
type:
type: string
required:
- fieldName
- type
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/public/custom-fields/update/{fieldId}:
put:
summary: Update
operationId: update
tags:
- Custom Fields
parameters:
- name: fieldId
in: path
required: true
description: fieldId of the custom field created earlier.
schema:
type: number
example: '376'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 5026
message: Custom field updation failed.
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
defaultValue:
type: string
dropDownOptions:
type: array
fieldDescription:
type: string
filterable:
type: boolean
isHidden:
type: boolean
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}:
get:
summary: Get
operationId: get
tags:
- Custom Fields
parameters:
- name: fieldId
in: path
required: true
description: fieldId of the custom field created earlier.
schema:
type: number
example: '376'
- name: locationBizNumber
in: path
required: true
description: Long Location number of the Location
schema:
type: number
example: '123456789'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 5025
message: Custom field not found.
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/public/custom-fields/getList?locationBizNumber={locationBizNumber}:
post:
summary: POST
operationId: post
tags:
- Custom Fields
parameters:
- name: locationBizNumber
in: path
required: true
description: Long Location number of the Location.
schema:
type: number
example: '123456789'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1027
message: Invalid business number.
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
page:
type: number
size:
type: number
searchStr:
type: string
sortBy:
type: string
orderBy:
type: string
required:
- page
- size
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/public/custom-fields/delete/{fieldId}:
delete:
summary: Delete
operationId: delete
tags:
- Custom Fields
parameters:
- name: fieldId
in: path
required: true
description: fieldId of the custom field created earlier.
schema:
type: number
example: '376'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 5028
message: Custom field delete failed.
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/public/custom-fields/associate:
put:
summary: Associate
operationId: associate
tags:
- Custom Fields
parameters: []
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 5028
message: Custom field delete failed.
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
fieldId:
type: number
fieldValue:
type: string
businessNumber:
type: number
required:
- fieldId
- fieldValue
- businessNumber
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/public/card:
post:
summary: Create Custom card
operationId: create-custom-card
tags:
- Custom Fields
parameters: []
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:
title:
type: string
description:
type: string
imageURL:
type: string
imagePosition:
type: number
isVisible:
type: number
isPinOnTop:
type: number
clickURL:
type: string
required:
- title
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
components:
schemas:
5031Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5031
message: Method not implemented for unknown custom field type.
1167Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1167
message: API key is missing
1027Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1027
message: Invalid business number.
5028Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5028
message: Custom field delete failed.
Apiary_create_Request:
type: object
properties:
defaultValue:
type: string
description: Default Value of custom field.
dropDownOptions:
type: array
description: The list of options in custom field.
items: {}
fieldDescription:
type: string
description: Description of custom field.
fieldName:
type: string
description: Name of custom field.
filterable:
type: boolean
description: 'Whether the custom field will be filterable or not. Default: false'
type:
type: string
description: Type of custom field.
required:
- fieldName
- type
example:
defaultValue: Green
dropDownOptions:
- Blue
- Green
- Red
fieldDescription: This custom field contains list of colours
fieldName: colours
filterable: 'false'
type: DROPDOWN_MULTI
5023Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5023
message: Custom field request dto cannot be null.
1011Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1011
message: Business id is invalid
5025Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5025
message: Custom field not found.
5022Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5022
message: Another custom field with same name already present.
5040Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5040
message: Max limit reached for custom fields.
1161Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1161
message: Invalid API key
5026Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5026
message: Custom field updation failed.
5039Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5039
message: Custom field name cannot be a reserved keyword.
5024Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 5024
message: Custom field creation failed.
Apiary_update_Request:
type: object
properties:
defaultValue:
type: string
description: Default Value of custom field.
dropDownOptions:
type: array
description: The list of options in custom field.The list of options in custom field
items: {}
fieldDescription:
type: string
description: Description of custom field.
filterable:
type: boolean
description: Whether the custom field will be filterable or not.
isHidden:
type: boolean
description: Whether the custom field will be hidden or not.
example:
defaultValue: Green
dropDownOptions:
- Blue
- Green
- Red
fieldDescription: This custom field contains list of colours
filterable: 'false'
isHidden: 'false'
89Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 89
message: Rate limit exceeded
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