pendingCustomersSummary

Requires a tenant administrator.

Returns how many customers are waiting for approval, plus the newest few. Light enough to poll. Tenant admins only.

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 PendingCustomersSummary {
  pendingCustomersSummary {
    count
    recent {
      id
      name
      createdById
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PendingCustomersSummary {\n  pendingCustomersSummary {\n    count\n    recent {\n      id\n      name\n      createdById\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "pendingCustomersSummary": {
      "count": 0,
      "recent": [
        {
          "id": "id",
          "name": "string",
          "createdById": "string"
        }
      ]
    }
  }
}

pendingCustomersSummary: PendingCustomersSummary!

Type

PendingCustomersSummary object

How many customers await approval, with the newest few.