Skip to main content
GET
Get

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. - Partner specific API key provided by Birdeye for data exchange.

x-business-number
string

e.g. - Long Business Number

Path Parameters

fieldId
number
required

fieldId of the custom field created earlier.

locationBizNumber
number
required

Long Location number of the Location

Response

OK

id
number

fieldId of the custom field.

Example:

376

fieldValue
string

Field Value of custom field and will only be visible if value is present.

Example:

"Green"

fieldName
string

Name of the custom field.

Example:

"colours"

type
string

Type of field.

Example:

"DROPDOWN_MULTI"

defaultValue
string

Default Value of custom field and will only be visible if value is present.

Example:

"Green"

fieldDescription
string

Description of custom field.

Example:

"This custom field contains list of colours"

filterable
boolean

Whether the custom field will be filterable or not.