Skip to main content
GET
/
users
Retrieve users list
curl --request GET \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/users \
  --header 'x-api-key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://fieldpulse.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
default:your-api-key-here
required

Query Parameters

​
limit
string

Defaults to 20 items per page, maximum 100 items allowed.

​
calculate_count
string

true or false. If true, in response will be included also total count

​
filter
string

Array of attribute, operator, and value parts.

​
sort
string

Array of attribute and order values.

​
rel
string

array consisting of indices with the desired relation to include

Response

200 - application/json

Successful response