organization

Requires an authenticated session.

Returns your own organization. The ID must be your own organization's; any other is refused. Its stats are filled in only for callers allowed to see organization-wide figures.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Organization($id: String!) {
  organization(id: $id) {
    id
    code
    postalCode
    registrationNumber
    name
    status
    stats {
      activeWarehhouses
      lastOrderDate
      totalOrders
      totalProducts
      totalRevenue
      totalUsers
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Organization($id: String!) {\n  organization(id: $id) {\n    id\n    code\n    postalCode\n    registrationNumber\n    name\n    status\n    stats {\n      activeWarehhouses\n      lastOrderDate\n      totalOrders\n      totalProducts\n      totalRevenue\n      totalUsers\n    }\n  }\n}",
  "variables": {
    "id": "string"
  }
}
EOF

Variables:

{
  "id": "string"
}

Response:

{
  "data": {
    "organization": {
      "id": "string",
      "code": "string",
      "postalCode": "string",
      "registrationNumber": "string",
      "name": "string",
      "status": "string",
      "stats": {
        "activeWarehhouses": 0,
        "lastOrderDate": "2025-01-15T00:00:00Z",
        "totalOrders": 0,
        "totalProducts": 0,
        "totalRevenue": 0,
        "totalUsers": 0
      }
    }
  }
}

organization(
  id: String!
): Organization!

Arguments

organization.id ● String! non-null scalar

The ID of the organization.

Type

Organization object

A seller organization: one tenant of the platform.