allUserRelationships

Requires permission users:user:read.

Get all user relationships in the organization

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 AllUserRelationships {
  allUserRelationships {
    id
    createdAt
    isActive
    notes
    organizationId
    relatedUserId
    relatedUser {
      id
      postalCode
      name
      firstName
      lastName
      status
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AllUserRelationships {\n  allUserRelationships {\n    id\n    createdAt\n    isActive\n    notes\n    organizationId\n    relatedUserId\n    relatedUser {\n      id\n      postalCode\n      name\n      firstName\n      lastName\n      status\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "allUserRelationships": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "isActive": true,
        "notes": "string",
        "organizationId": "string",
        "relatedUserId": "string",
        "relatedUser": {
          "id": "id",
          "postalCode": "string",
          "name": "string",
          "firstName": "string",
          "lastName": "string",
          "status": "ACTIVE"
        }
      }
    ]
  }
}

allUserRelationships: [UserRelationship!]!

Type

UserRelationship object

A relationship between two users, such as who reports to whom.