nowcerts_agent_getList
Retrieve agent records from NowCerts with filtering, sorting, and pagination options to manage insurance agent data efficiently.
Instructions
Retrieve agents from NowCerts using OData query parameters.
IMPORTANT: By default, results are ordered by 'changeDate desc' (most recently changed first). The 'changeDate' field exists on all entities.
Common $filter examples:
Active agents only: "active eq true"
Search by first name: "contains(firstName, 'John')"
Search by last name: "contains(lastName, 'Smith')"
Search by email: "contains(email, 'agent@example.com')"
By role: "primaryRole eq 'Agent/Producer'" or "primaryRole eq 'CSR'"
Default agent: "isDefaultAgent eq true"
Has user account: "userId ne null"
Multiple conditions: "active eq true and contains(lastName, 'Smith')"
Pagination examples:
First 100 active agents: $filter=active eq true&$top=100&$skip=0&$orderby=firstName asc&$count=true
Next 100: $filter=active eq true&$top=100&$skip=100&$orderby=firstName asc&$count=true
Available fields: id (primary key), firstName, lastName, email, phone, cellPhone, fax, npnNumber, primaryRole, assignCommissionIfCSR, isDefaultAgent, useAgentIfNotDefault, primaryOfficeName, active, changeDate, userId, userDisplayName, addressLine1, addressLine2, city, state, county, zipCode, isSuperVisior, agentIs, workGroups (list)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| $count | No | Include total count in response. Set to true to get @odata.count field. | |
| $filter | No | OData filter expression (optional). Example: 'active eq true' | |
| $orderby | No | Field to order by. Default: 'changeDate desc'. Examples: 'firstName asc', 'lastName desc', 'changeDate desc' | |
| $select | No | Comma-separated list of columns to return (optional). Example: 'id,firstName,lastName,email,active' | |
| $skip | No | Number of records to skip (offset). Example: 0 for first page, 100 for second page | |
| $top | No | Number of records to return (limit). Example: 100 |