Skip to content
SynupAPI
Get an API key

UsersResponse

Fields

NameTypeRequiredDescription
dataobjectoptional
data.usersobjectoptional
data.users.totalCountintegeroptionalTotal number of users in the system
data.users.pageInfoobjectoptional
data.users.pageInfo.hasNextPagebooleanoptionalIndicates if there are more pages after the current page
data.users.pageInfo.hasPreviousPagebooleanoptionalIndicates if there are previous pages before the current page
data.users.pageInfo.totalintegeroptionalNumber of items in the current page
data.users.pageInfo.endCursorstringoptionalCursor for the last item in the current page
data.users.edgesarray of objectoptional
data.users.edges[].cursorstringoptionalUnique cursor for this user record
data.users.edges[].nodeobjectoptional
data.users.edges[].node.idstringrequiredUnique identifier for the user
data.users.edges[].node.emailstringrequiredUser's email address
data.users.edges[].node.firstNamestringrequiredUser's first name
data.users.edges[].node.lastNamestringoptionalUser's last name (optional)
data.users.edges[].node.customRoleobjectrequired
data.users.edges[].node.customRole.idstringoptionalRole identifier
data.users.edges[].node.customRole.namestringoptionalRole name
data.users.edges[].node.directCustomerbooleanrequiredIndicates if the user is a direct customer
data.users.edges[].node.createdAtstringrequiredTimestamp when the user was created
data.users.edges[].node.inviteStatusstringrequiredCurrent status of the user's invitation
ACTIVEINVITE_SENTRESEND_INVITE