Actions67
- Account Actions
- Asset Actions
- Asset Type Actions
- Base Data Actions
- Call Actions
- Contact Actions
- Contract Actions
- Crew Actions
- Document Actions
- Employee Actions
- Hours Actions
- Hour Type Actions
- Work Order Actions
Contact → Get List
AI-generatedSummary
Retrieve a list of Contact records with optional filtering, pagination, and request configuration.
Inputs
- returnAll — Whether to return all results or only up to a given limit
- limit — Maximum number of contacts to return (1‑500). Ignored when returnAll is true.
- filters — Define filter criteria such as Contact ID, Last Name, First Name, Initials, Email, or Telephone.
- requestOptions — Additional request settings including batching, SSL verification, proxy, and timeout.
Output shape
a list of Contact records
Returned results respect the limit; when returnAll is true the limit parameter is ignored. Filters are applied as query parameters.
Examples
Example 1: Get up to 100 contacts without pagination
returnAll=false, limit=100, filters={}, requestOptions={}
Example 2: Search contacts by email address
filters={conEmail:'user@example.com'}, limit=50, requestOptions={}
Example 3: Batch retrieve with batch size 200
requestOptions.batch.batchSize=200, limit=200, filters={}, requestOptions.timeout=10000