Organizations
Search for organizations
This endpoint lets you search for organizations using filters. The response is paginated (30 results per page).
get/org/search
Query parameters
org_idinteger
Filter by organization ID. Only PROVIDER users can use this filter. If you are not a PROVIDER, this will default to the ID of your organization.
querystring
Parameter to fuzzy search organizations on name or id
aliasstring
Parameter to search an organization by its alias
pageinteger
Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.
per_pageinteger
Number of items to return per page. Currently limited to 100.
Response
OK
Example response
{
"page": 1,
"max_page": 10,
"count": 287,
"orgs": [
{
"org_id": 42,
"name": "Fast Retailer",
"alias": "fast_retailer",
"provider": "partoo",
"features": [
"business_edition",
"diffusion",
"review_management",
"review_invite",
"messages"
],
"org_features": [
"business_edition",
"diffusion",
"review_management",
"review_invite",
"messages",
"review_ai_suggestion"
],
"last_org_api_call": "05-11-2021",
"max_businesses": 100
}
]
}