List Businesses

get

https://api.firstorion.com/exchange/v1/businesses

Retrieve a list of all registered Businesses. A Business represents the Enterprise or top-level entity responsible for managing the associated Business Units. This includes a Branded Calling Partner.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 1024

Defaults to 20

How many items are included in the response

pageHash

string

System Generated Page identifier

status

string

Retrieve only businesses that are in the specified status. Value is case sensitive. Matching is done using "exact match" function.

legalName

string

Filter down businesses by matching the legalName to the provided value. Provided string should be url encoded and it is case sensitive. Matching is done using "starts with" function.

dba

string

Filter down businesses by matching the dba (Doing Business As) to the provided value. Provided string should be url encoded and it is case sensitive. Matching is done using "starts with" function.

dunsNumber

string

Filter down businesses by matching the dunsNumber to the provided value. Provided string should be url encoded. Matching is done using "exact match" function.

serviceGrantList

string

enum

Find businesses that has the provided ServiceGrant. Matching is done using "has" function.

Allowed:

Headers

Authorization

string

required

Access Token

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK