Skip to main content
GET
/
org
/
search
Search for organizations
curl --request GET \
  --url https://api.partoo.co/v2/org/search \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "orgs": [
    {
      "org_id": 42,
      "name": "Fast Retailer",
      "alias": "fast_retailer",
      "provider": "partoo",
      "type": "small_medium_business",
      "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.partoo.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
org_id
integer

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.

​
query
string

Parameter to fuzzy search organizations on name or id

​
alias
string

Parameter to search an organization by its alias

​
page
integer
default:1

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_page
integer
default:30

Number of items to return per page. Currently limited to 100.

Required range: 1 <= x <= 100

Response

OK

Result object return by the API

​
page
integer

Current page number

Example:

1

​
max_page
integer

Last page number

Example:

10

​
count
integer

Number of resources complying with filters

Example:

287

​
orgs
object[]

The organizations complying with filter (30 max per page)