v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB

Organizations

Organization information

This endpoint lets you retrieve all the detail about a specific organization. You need to have READ access to this organization.

get/org/{org_id}

Path parameters

org_idinteger required

Unique ID of the organization to which the resource belongs. Only PROVIDER users can access resources from a different organization than their own. If you are not a PROVIDER, this will default to the ID of your organization.

Response

org_idinteger

Unique identifier of an organization in Partoo.

namestring

Organization name

aliasstring

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

providerstring

Organization provider

type'small_medium_business' | 'enterprise'

Organization type

featuresFeature[]

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.

org_featuresFeature[]

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

last_org_api_callstring

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

max_businessesinteger nullable

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 user.

Example response

{
  "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
}