Actions38
- Bookings Actions
- Customers Actions
- Agents Actions
- Services Actions
- Payments Actions
- Orders Actions
- Coupons Actions
- Locations Actions
- Availability Actions
Agents → Get All
AI-generatedSummary
Lists agents (staff members) from a LatePoint site via GET /agents, with optional filtering, sorting and pagination (single page or all pages).
Inputs
- Use Filters — Toggle (default off) that reveals the predefined Filters collection. When off, only Additional Filters (JSON) is applied.
- Filters — Collection of optional filters: First Name, Last Name, Email, Phone, Status (active/inactive), Location ID, Service ID, Created Date From/To (YYYY-MM-DD), Search, Sort By (id, first_name, last_name, email, created_at), Sort Order (asc/desc), Include Meta, Meta Key, Meta Value. Empty values are skipped. Created dates are sent as created_after/created_before and Sort By as order_by.
- Additional Filters (JSON) — JSON object of extra query parameters using API parameter names. Merged into the query string after the predefined filters and overrides them on key conflicts. Works without Use Filters. Invalid JSON is silently ignored.
- Return All — If true, automatically fetches every page and emits one item per agent. Default false.
- Max Pages — Shown when Return All is on. Caps the number of pages fetched; 0 means unlimited.
- Limit — Shown when Return All is off. Results per page (sent as per_page), 1–100, default 10.
- Page — Shown when Return All is off. Page number to fetch, default 1.
- Description — Free-text note for AI context; not used in the request.
Output shape
With Return All off: one item containing the raw API response (agent records in data plus a pagination object). With Return All on: one item per agent record, collected across pages.
Pagination continues while the API's pagination.has_next_page is true, up to Max Pages if set. Errors throw unless Continue On Fail is enabled, in which case an item with an
errormessage is emitted. Uses the credential's base URL and API key as a Bearer token.
Examples
Example 1: Fetch all active agents who offer a given service, sorted by last name
Use Filters on; Filters: Status=active, Service ID=7, Sort By=last_name; Return All on.
Example 2: Browse agents page by page
Return All off; Limit=25; Page=2; no filters.
Example 3: Filter by a parameter not exposed in the UI
Additional Filters (JSON): {"location_id": 3}; Return All off.