Actions31
- Auth Actions
- Car Actions
- Dashboard Actions
- Device Actions
- Organization Actions
- Place Actions
- User Actions
Place → Get Users
AI-generatedSummary
Fetch users belonging to a specified place with optional pagination, filtering, and batching controls.
Inputs
- placeId (required) — The ID of the place whose users are to be retrieved.
- returnAll — If true, returns all users regardless of limit; otherwise respects the limit parameter.Default: false
- limit — Maximum number of users to return when returnAll is false. Valid range 1‑100. Default: 50
- skip — Number of user records to skip before returning results. Default: 0
- filter — Optional search string to filter users by phone, name, or car number.
- requestOptions — Advanced options such as batching, SSL verification, proxy, and timeout for the request.
Output shape
a paginated list of user objects
When returnAll is false the response respects the limit and skip parameters; when true the node attempts to retrieve all users (subject to API limits). Individual user objects contain the fields returned by the PAL Gate API (e.g., id, name, phone, cars).
Examples
Example 1: Fetch up to 20 users from a place, skipping the first 10, with a filter for a specific phone number
placeId: "123"
returnAll: false
limit: 20
skip: 10
filter: "972501234567"
Example 2: Retrieve all users for a place using batching to throttle requests
placeId: "456"
returnAll: true
requestOptions: {"batching": {"batchSize": 50}}
Example 3: Get a single page of users with the default limit (50)
placeId: "789"
limit: 50