List in-scope Organizations

You can find organizations the client's scope applies to - you can further filter this list by using one or more parameters for:

  • name (Full or partial name of an organization)
  • status (if organizations are 'Active' or 'Closed')

Note: Unfiltered requests will return both Active and Closed organizations. Results are ordered by name ascending.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

One or more terms between spaces which will each be matched partially against the name of the merchant

string
enum

Only include organizations matching the specified status - Active/Closed

Allowed:
int32
required

The page parameter (Note: page numbering starts at 0)

int32
required

The page size parameter (Note: default page size is 25)

Responses

400

The server will not process the request due to a client error

401

Request failed because the client was not authorized to perform this action

404

Could not find resource

429

Request was throttled due to too many requests from this client or IP address

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json