organizationBySubdomain

Requires an authenticated session.

Returns your own organization by its subdomain. Another organization's subdomain reads as not found.

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 OrganizationBySubdomain($subdomain: String!) {
  organizationBySubdomain(subdomain: $subdomain) {
    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 OrganizationBySubdomain($subdomain: String!) {\n  organizationBySubdomain(subdomain: $subdomain) {\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": {
    "subdomain": "string"
  }
}
EOF

Variables:

{
  "subdomain": "string"
}

Response:

{
  "data": {
    "organizationBySubdomain": {
      "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
      }
    }
  }
}

organizationBySubdomain(
  subdomain: String!
): Organization!

Arguments

organizationBySubdomain.subdomain ● String! non-null scalar

Your organization's subdomain.

Type

Organization object

A seller organization: one tenant of the platform.