Users
Use the users
query to obtain a list of all registered users on your account. In addition, search for a specific user or a profile user by sending the userId
or profileId
as an argument.
User Role
users
: list the created user.
Available Arguments
Argument Name
Required?
Type
Description
userUUIDs
No
String
User database ID
profileUUIDs
No
String
User profile database ID
filters.createdAt.start
No
Date
Allows to filter users by createdAt
field, both start
and end
fields are mandatory when using this filter. (example below)
filters.createdAt.end
No
Date
Allows to filter users by createdAt
field, both start
and end
fields are mandatory when using this filter. (example below)
Available Fields
Field
Type
Description
name
String
Users name
email
String
Users email
phone
String
users phone number
databaseId
Sting
User's ID
Examples
Get the list of all users
{
users {
edges {
node {
name
phone
email
databaseId
}
}
}
}
Get list of users created under desired date range
{
users (filters:{createdAt:{start:"2024-01-10" end:"2024-02-10"} }) {
edges {
node {
name
phone
email
databaseId
createdAt
}
}
}
}
Search for a user by ID
{
users (userUUIDs: "9bdc5da1-ae2d-4a61-90f7-7dd8ee59663a"){
edges {
node {
id
databaseId
name
email
isActive
profileId
updatedAt
}
}
}
}
Search for a user by profile ID
{
users(profileUUIDs: "217adfda-c08e-494c-bc25-f08e41c54767") {
edges {
node {
id
databaseId
name
email
isActive
profileId
updatedAt
}
}
}
}
Last updated
Was this helpful?