Skip to main content

Users

Reference documentation for GraphQL schema types in the Users category.

In this article

Queries

user

Query

Lookup a user by login.

Type: User

Arguments for user

NameDescription

login (String!)

The user's login.

users

Query

A list of users.

Type: UserConnection!

Arguments for users

NameDescription

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewer

Query

The currently authenticated user.

Type: User!

Mutations

changeUserStatus

Mutation

Update your status on GitHub.

Input fields for changeUserStatus

Return fields for changeUserStatus

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.

createUserList

Mutation

Creates a new user list.

Input fields for createUserList

Return fields for createUserList

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

list (UserList)

The list that was just created.

viewer (User)

The user who created the list.

deleteUserList

Mutation

Deletes a user list.

Input fields for deleteUserList

Return fields for deleteUserList

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The owner of the list that will be deleted.

followUser

Mutation

Follow a user.

Input fields for followUser

Return fields for followUser

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (