Skip to main content
GET
Typescript (SDK)

Authorizations

Syllable-API-Key
string
header
required

Path Parameters

user_email
string
required

Response

Successful Response

Information about a user.

email
string
required

Email address of the user

Example:

"user@syllable.ai"

role_id
integer
required

ID of the role assigned to the user

Example:

1

id
integer
required

Internal ID of the user

Example:

1

role_name
string
required

Name of the role assigned to the user

Example:

"Admin"

email_sent
boolean
required

Whether the welcome email has been sent to the user

Example:

true

activity_status
enum<string>
required

The activity status of the user

Available options:
not_invited,
invited,
active
Example:

"invited"

last_updated
string<date-time>
required

The timestamp of the most recent update to the user

first_name
string | null

First name of the user

Example:

"Jane"

last_name
string | null

Last name of the user

Example:

"Smith"

utm
DaoUtm · object | null

Optional UTM campaign attribution to record in user_metadata.

last_updated_comments
string | null

Comments for the most recent edit to the user.

Example:

"Updated to change which role was assigned"

last_updated_by
string | null

The email address of the user who last updated the user

Example:

"admin@email.com"

last_session_at
string<date-time> | null

The timestamp of the user's last session

Example:

"2025-01-01T12:00:00Z"