nowcerts_principal_getList
Retrieve principals and contacts from NowCerts using OData queries to filter, sort, and paginate through additional insureds and interested parties data.
Instructions
Get principals/contacts (additional insureds/interested parties) from NowCerts using OData query parameters.
IMPORTANT: By default, results are ordered by 'changeDate desc' (most recently changed first).
ID FIELD NAMING:
Principal's own ID: "databaseId" (primary UUID key)
Link to insured: "insuredDatabaseId" (insured's UUID)
Common $filter examples:
Search by ID: "databaseId eq '7c8b37f8-e4d0-42f9-a7d0-ffefd163f657'"
Search by first name: "contains(firstName, 'John')"
Search by last name: "contains(lastName, 'Smith')"
Search by personal email: "contains(personalEmail, 'test@example.com')"
Search by business email: "contains(businessEmail, 'business@example.com')"
By type: "type eq 'Owner'" or "type eq 'Spouse'" or "type eq 'Other'"
By insured ID: "insuredDatabaseId eq 'guid-here'"
By insured name: "contains(insuredFirstName, 'John') or contains(insuredLastName, 'Smith')"
Recent changes: "changeDate ge 2024-01-01T00:00:00Z"
By gender: "gender eq 'Male'" or "gender eq 'Female'"
Pagination examples:
All contacts for insured: $filter=insuredDatabaseId eq 'guid-here'&$top=100&$skip=0&$orderby=lastName asc&$count=true
Owners only: $filter=type eq 'Owner'&$top=50&$skip=0&$orderby=changeDate desc&$count=true
Available fields: databaseId (primary key), firstName, middleName, lastName, description, type, personalEmail, businessEmail, homePhone, officePhone, cellPhone, personalFax, businessFax, ssn, birthday, insuredDatabaseId, insuredEmail, insuredFirstName, insuredLastName, insuredCommercialName, changeDate, dlNumber, dlYear, dlStateName, education, gender, industryName, isHealthPlanMember
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). Can be combined with other parameters. | |
| $orderby | No | Field to order by. Default: 'changeDate desc'. Example: 'PrincipalName asc' | |
| $select | No | Comma-separated list of columns to return (optional) | |
| $skip | No | Number of records to skip (offset). Example: 0 | |
| $top | No | Number of records to return (limit). Example: 100 |