getExistingOrganizations

Public: no authentication required.

Lists the organizations a Google account already belongs to, with its name and picture, for the sign-up page. Needs no sign-in.

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 GetExistingOrganizations($googleToken: String!) {
  getExistingOrganizations(googleToken: $googleToken) {
    name
    avatar
    email
    hasExistingOrganizations
    organizations {
      organizationName
      createdAt
      logoUrl
      organizationId
      role
      subdomain
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query GetExistingOrganizations($googleToken: String!) {\n  getExistingOrganizations(googleToken: $googleToken) {\n    name\n    avatar\n    email\n    hasExistingOrganizations\n    organizations {\n      organizationName\n      createdAt\n      logoUrl\n      organizationId\n      role\n      subdomain\n    }\n  }\n}",
  "variables": {
    "googleToken": "string"
  }
}
EOF

Variables:

{
  "googleToken": "string"
}

Response:

{
  "data": {
    "getExistingOrganizations": {
      "name": "string",
      "avatar": "string",
      "email": "string",
      "hasExistingOrganizations": true,
      "organizations": [
        {
          "organizationName": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "logoUrl": "string",
          "organizationId": "string",
          "role": "string",
          "subdomain": "string"
        }
      ]
    }
  }
}

getExistingOrganizations(
  googleToken: String!
): ExistingOrganizationsResponse!

Arguments

getExistingOrganizations.googleToken ● String! non-null scalar

The Google ID token that proves the account.

Type

ExistingOrganizationsResponse object

The organizations a person already belongs to.