Get a list of available businesses

The endpoint returns a list of all businesses enabled globally for the Partner

SecuritybearerAuth
Request
query Parameters
external_id
string

Query to search businesses by external ID

Example: external_id=ext-id
name
string

Query to search businesses by name

Example: name=test
pid
string <uuid>

Query to search businesses by PID

Example: pid=550e8400-e29b-41d4-a716-446655440000
status
string

Filter businesses by status

Enum: "approved" "not_approved"
Example: status=approved
page_size
integer

Number of elements to be displayed on a page

Example: page_size=1
page
integer

Display page number

Example: page=1
sort_by
string

Sort businesses

Enum: "name" "reviewed_at" "created_at"
Example: sort_by=reviewed_at
sort_order
string

Sort order

Enum: "asc" "desc"
Example: sort_order=desc
Responses
200

List businesses

401

Invalid user

403

Forbidden

422

Error

500

Internal Error

503

Maintenance or Service unavailable

get/v1/businesses
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}