Skip to main content
GET
Get a user

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.

Path Parameters

user_id_or_name
string
required

Response

Successful response

id
string<uuid>
created_at
string<date-time>
updated_at
string<date-time>
email
string
Maximum string length: 100
name
string

The unique name identifying this account.

Maximum string length: 100
cached_forks_count
integer

A cached version of the forks count. Might not be up to date.

cached_forks_public_count
integer

A cached version of the forks count for public agents. Might not be up to date.

cached_installs_count
integer

A cached version of the installs count. Might not be up to date.

cached_installs_public_count
integer

A cached version of the installs count for public agents. Might not be up to date.

cached_likes_count
integer

A cached version of the likes count. Might not be up to date.

cached_likes_public_count
integer

A cached version of the likes count for public agents. Might not be up to date.

is_operator
boolean

Whether or not the user is a Guild employee (or operator). BE VERY CAREFUL WITH THIS.

notification_email_level
enum<string>

NONE = no emails, IMPORTANT = invitations and agent-ask only, ALL = all notification types.

Available options:
NONE,
IMPORTANT,
ALL
avatar_url
string | null
Maximum string length: 255
banner_url
string | null
Maximum string length: 255
bio
string | null
Maximum string length: 255
closed_at
string<date-time> | null

Set when an operator closes the account. A closed user cannot start a login session by any method.

closure_requested_at
string<date-time> | null

Set when an admin asks support to close the account, so a repeated request does not email support again.

closure_requested_by_id
string<uuid> | null
discord_url
string | null
Maximum string length: 255
full_name
string | null

The display name of the account.

Maximum string length: 100
github_url
string | null
Maximum string length: 255
hubspot_synced_at
string<date-time> | null
linkedin_url
string | null
Maximum string length: 255
threads_url
string | null
Maximum string length: 255
username_set_at
string<date-time> | null

Set when the user picks their username during onboarding. Once set, the username cannot be changed.

website_url
string | null
Maximum string length: 255
x_url
string | null
Maximum string length: 255
youtube_url
string | null
Maximum string length: 255
type
enum<string>

Account type, always "user"

Available options:
user