Skip to main content
POST
List metadata attached to a business

Authorizations

api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
business_id
string
required

Identifier of the target business. Required when the endpoint operates on a specific business.

Example:

"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"

api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

Free-text search filter. Matches common fields on the target collection.

page
integer
default:1

Page number, 1-indexed. Defaults to 1 when omitted.

Required range: x >= 1
per_page
integer
default:10

Page size. Defaults to 10 when omitted.

Required range: 1 <= x <= 500

Response

Success.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.