List Team Merchants

Returns a searchable, paginated list of merchants the caller is authorized to manage. This is the data source for merchant pickers used when granting or editing user access.

For merchant admins, the list is scoped to merchants they hold an active admin membership on. For system_admin users, the list includes all merchants permitted by their godview brand permissions, and a search term (q) is required.

Query Params
string
length ≤ 255

Search term to filter merchants by company name or pMID. Required for system_admin callers. For merchant admins, omitting this returns the full administered set.

integer
1 to 200
Defaults to 20

Number of results per page.

Responses

401

Authentication failed or the caller does not have team admin access.

422

Validation failed. For system_admin callers, this is returned when the required q parameter is missing or per_page is out of range.

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