appmixer.xero.accounting.ListContacts
1.0.0
Public
| Field | Type | Description |
|---|---|---|
| Tenant ID | select | - |
| Output Type | select | Choose whether you want to receive the result set as one complete list, or one item at a time or stream the items to a file. For large datasets, streaming the rows to a file is the most efficient method. |
| IDs | text | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. |
| Include Archived | toggle | Contacts with a status of ARCHIVED will be included in the response. By default only contacts of status ACTIVE will be returned. |
| Order by an any element | text | - |
| Search Term | text | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. |
| Summary Only | toggle | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. |
| Where | text | Filter by an any element |
Dynamic variables loaded from /component/appmixer/xero/accounting/ListContacts?outPort=contacts&ignoreAuth=true