Query
query Customers {
customers {
edges {
cursor
node {
id
externalId
fullName
shortName
email {
__typename
}
avatarUrl
}
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
totalCount
}
}Response
{
"data": {
"customers": {
"edges": [
{
"cursor": "string",
"node": {
"id": "id",
"externalId": "id",
"fullName": "string",
"shortName": "string",
"email": {
"__typename": "EmailAddress"
},
"avatarUrl": "string"
}
}
],
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
},
"totalCount": 1
}
}
}Queries
customers
Fetch a paginated list of all customers in the workspace. Supports filtering by group membership,
company, spam status and more via filters, and ordering via sortBy. Use cursor-based pagination
(first/after or last/before) to page through large result sets. Requires the customer:read permission.
QUERY
customers(filters: CustomersFilter, sortBy: CustomersSort, first: Int, after: String, last: Int, before: String): CustomerConnection!Arguments
filters
sortBy
first
Int
after
String
last
Int
before
String
Returns
edges
[CustomerEdge!]!
pageInfo
totalCount
Int!
Query
query Customers {
customers {
edges {
cursor
node {
id
externalId
fullName
shortName
email {
__typename
}
avatarUrl
}
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
totalCount
}
}Response
{
"data": {
"customers": {
"edges": [
{
"cursor": "string",
"node": {
"id": "id",
"externalId": "id",
"fullName": "string",
"shortName": "string",
"email": {
"__typename": "EmailAddress"
},
"avatarUrl": "string"
}
}
],
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
},
"totalCount": 1
}
}
}Was this page helpful?