Actions62
- Agent Actions
- Agent Version Actions
- Board Actions
- Call Actions
- Channel Actions
- Contact Actions
- Conversation Actions
- Credit Actions
- Event Actions
- Phone Number Actions
- Tag Actions
- Task Actions
- Voice Actions
- WhatsApp Actions
Contact → Get Many
AI-generatedSummary
Retrieve multiple contacts from ContactShip with optional filtering by email, full name, or phone number, sorting by creation date, and controlling the number of results returned.
Inputs
- Return All — Whether to return all matching contacts or only up to a set limit.
- Limit — Maximum number of contacts to return when Return All is false.
- Filters — Optional filters to narrow contacts by email substring, full name substring, or phone number substring.
- Sort — Sorting order by creation date, either newest first (descending) or oldest first (ascending).
Output shape
A list of contact records, each representing a contact matching the applied filters and sorting, up to the specified limit or all if Return All is true.
If Return All is false, the number of returned contacts is capped by the Limit parameter. Filters are applied as partial matches to email, full name, and phone number fields. Sorting is based on creation date. The output contains contact details as provided by the ContactShip API.
Examples
Example 1: Fetch up to 50 contacts whose email contains 'example.com', sorted by newest first.
Return All: false; Limit: 50; Filters: Email contains 'example.com'; Sort: Newest First
Example 2: Fetch all contacts whose full name contains 'Nathan', with oldest contacts first.
Return All: true; Filters: Full Name contains 'Nathan'; Sort: Oldest First