usersFiltered

Requires at least one of the permissions sales:quote:create, sales:quote:update, settings:user:read or users:user:read.

Lists the users of your own organization, using the filters and paging in the input. Needs the users read permission, or the quote create or update permission (the quote owner picker).

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query UsersFiltered {
  usersFiltered {
    hasNextPage
    hasPreviousPage
    totalCount
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query UsersFiltered {\n  usersFiltered {\n    hasNextPage\n    hasPreviousPage\n    totalCount\n    pageInfo {\n      endCursor\n      hasNextPage\n      hasPreviousPage\n      startCursor\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "usersFiltered": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "totalCount": 0,
      "pageInfo": {
        "endCursor": "string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "string"
      }
    }
  }
}

usersFiltered(
  input: GetUsersInput
): PaginatedUsersResponse!

Arguments

usersFiltered.input ● GetUsersInput input

Optional filters and paging options.

Type

PaginatedUsersResponse object

A page of users.