List all Businesses

get https://api.middesk.com/v1/businesses

This endpoint will allow you to see the details of all Businesses that you have run through Middesk.

Query Params

page (optional)

string

Defaults to 1

The page offset at which you'd like to resume fetching Businesses.

per_page (optional)

string

Defaults to 25

The number of Businesses to fetch. Default: 25 Minimum: 1 Maximum: 30

batch_id (optional)

string

The business_batch_id returned when submitting businesses via the Create a Business Batch endpoint.

external_id (optional)

string

Filters businesses by external_id.

tags (optional)

string

Filter businesses by tags. Use a comma to separate each tag "tag1,tag2."

unique_external_id (optional)

string

Filters businesses by unique_external_id

start_date (optional)

string

Filter for all Businesses created after this date

end_date (optional)

string

Filter for all Businesses created before this date

status (optional)

string

Filter for all Businesses with this status (open, pending, approved, rejected, in_review, in_audit)

Response

Language

Credentials

Header

Request


xxxxxxxxxx
1
curl 'https://api.middesk.com/v1/businesses?page=1&per_page=25' \
2
  -u [API_key]: \
3
  -H "Accept: application/json"

Choose an example:

application/json

200200