Skip to content
Catalyzed Docs

List user emails

GET
/user-emails

List all email addresses for the authenticated user

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
userEmailIds
string
nullable
userIds
string
nullable
emails
string
nullable
isPrimary
boolean
nullable
isVerified
boolean
nullable
page
number
>= 1
pageSize
number
>= 1 <= 100
orderBy
string
Allowed values: createdAt verifiedAt
orderDirection
string
Allowed values: asc desc

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Emails retrieved successfully

object
userEmails
required
Array<object>
object
userEmailId
required
string
userId
required
string
email
required
string format: email
isPrimary
required
boolean
verifiedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
number
page
required
number
pageSize
required
number

403

Section titled “403 ”

Forbidden - insufficient permissions to access requested emails

object
error
required
string
code
string
details
nullable