userSubordinates

Requires permission users:user:read.

Get all user IDs who report to the specified user

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 UserSubordinates($userId: String!) {
  userSubordinates(userId: $userId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query UserSubordinates($userId: String!) {\n  userSubordinates(userId: $userId)\n}",
  "variables": {
    "userId": "string"
  }
}
EOF

Variables:

{
  "userId": "string"
}

Response:

{
  "data": {
    "userSubordinates": [
      "string"
    ]
  }
}

userSubordinates(
  recursive: Boolean = true
  types: [String!]
  userId: String!
): [String!]!

Arguments

userSubordinates.recursive ● Boolean scalar

True to include indirect reports, not just direct ones.

userSubordinates.types ● [String!] list scalar

Only subordinates of these user types.

userSubordinates.userId ● String! non-null scalar

The ID of the manager.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.