Skip to main content
GET
/
org
/
{org_id}
Organization information
curl --request GET \
  --url https://api.partoo.co/v2/org/{org_id} \
  --header 'x-APIKey: <api-key>'
{
  "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
}

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.

Path Parameters

​
org_id
integer
required

Organization id

Response

OK

Organization

​
org_id
integer

Organization id

Example:

42

​
name
string

Organization name

Example:

"Fast Retailer"

​
alias
string

Organization alias (should match regex [a-z0-9_])

Example:

"fast_retailer"

​
provider
string

Organization provider

Example:

"partoo"

​
type
enum<string>
default:small_medium_business

Organization type

Available options:
small_medium_business,
enterprise
​
features
enum<string>[]

List of organization's available features. Contains the features the organization can subscribe to as well as the ones only some businesses may have subscribed to additionally.

Business feature name

Available options:
diffusion,
feedback_management,
messages,
posts,
review_invite,
review_management
Example:
[
  "business_edition",
  "diffusion",
  "review_management",
  "review_invite",
  "messages"
]
​
org_features
enum<string>[]

List of organization's features. Only contains the features the organization has subscribed to.

Business feature name

Available options:
diffusion,
feedback_management,
messages,
posts,
review_invite,
review_management
Example:
[
  "business_edition",
  "diffusion",
  "review_management",
  "review_invite",
  "messages",
  "review_ai_suggestion"
]
​
last_org_api_call
string

Date of the last API call made with one of the API keys linked to the organization

Example:

"05-11-2021"

​
max_businesses
integer | null

Maximum number of local businesses the organization can have. It does not include the global (brand) businesses. If null, there is no limit for the organization. This field can only be set by a provider.

Example:

100