Skip to main content

UserRelationship

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

type UserRelationship {
createdAt: DateTime!
id: ID!
isActive: Boolean!
notes: String
organizationId: String!
relatedUser: User
relatedUserId: String!
relationshipType: UserRelationshipType!
updatedAt: DateTime!
user: User
userId: String!
}

Fields​

UserRelationship.createdAt ● DateTime! non-null scalar​

When the record was created.

UserRelationship.id ● ID! non-null scalar​

The unique ID of this record.

UserRelationship.isActive ● Boolean! non-null scalar​

Whether the record is active.

UserRelationship.notes ● String scalar​

Notes about the relationship.

UserRelationship.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

The supervisor or other related user.

The ID of the related user.

UserRelationship.relationshipType ● UserRelationshipType! non-null enum​

The kind of relationship.

UserRelationship.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

UserRelationship.user ● User object​

The subordinate.

UserRelationship.userId ● String! non-null scalar​

The ID of the user.

Returned By​

addUserRelationship mutation ● allUserRelationships query ● removeUserRelationship mutation ● updateUserRelationship mutation

Member Of​

UserRelationshipSummary object