Unipile: List Email Contacts

List contacts from a connected Gmail/Google or Microsoft/Outlook account (not supported for IMAP).

Tool ID: unipile_list_email_contacts

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_list_email_contacts',
  {
    "account_id": "123456789"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_list_email_contacts --input '{
  "account_id": "123456789"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe unipile_list_email_contacts --json for the complete live contract.

Input reference

Returns a list of contacts from the email provider. Supported for Gmail (Google OAuth) and Microsoft (Outlook) only.

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. Minimum length: 1.
`payload.limit`	`integer`	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250. Minimum: 1. Maximum: 250.
`payload.account_id`	`string`	Yes	—	A filter to target items related to a certain account.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.object`	`"EmailContactList"`	Yes	—	Allowed: `EmailContactList`.
`result.data.items`	`array`	Yes	—	—
`result.data.items[].object`	`"contact"`	Yes	—	Allowed: `contact`.
`result.data.items[].id`	`string`	Yes	—	—
`result.data.items[].account_id`	`string`	Yes	—	—
`result.data.items[].source`	`string`	No	—	—
`result.data.items[].given_name`	`string`	No	—	—
`result.data.items[].middle_name`	`string`	No	—	—
`result.data.items[].surname`	`string`	No	—	—
`result.data.items[].nickname`	`string`	No	—	—
`result.data.items[].suffix`	`string`	No	—	—
`result.data.items[].birthday`	`string`	No	—	—
`result.data.items[].company_name`	`string`	No	—	—
`result.data.items[].job_title`	`string`	No	—	—
`result.data.items[].manager_name`	`string`	No	—	—
`result.data.items[].notes`	`string`	No	—	—
`result.data.items[].office_location`	`string`	No	—	—
`result.data.items[].picture_url`	`string`	No	—	—
`result.data.items[].emails`	`array`	Yes	—	—
`result.data.items[].emails[].email`	`string`	Yes	—	—
`result.data.items[].emails[].type`	`string`	No	—	—
`result.data.items[].phone_numbers`	`array`	Yes	—	—
`result.data.items[].phone_numbers[].number`	`string`	Yes	—	—
`result.data.items[].phone_numbers[].type`	`string`	No	—	—
`result.data.items[].im_addresses`	`array`	Yes	—	—
`result.data.items[].im_addresses[].im_address`	`string`	Yes	—	—
`result.data.items[].im_addresses[].type`	`string`	No	—	—
`result.data.items[].physical_addresses`	`array`	Yes	—	—
`result.data.items[].physical_addresses[].city`	`string`	No	—	—
`result.data.items[].physical_addresses[].country`	`string`	No	—	—
`result.data.items[].physical_addresses[].postal_code`	`string`	No	—	—
`result.data.items[].physical_addresses[].state`	`string`	No	—	—
`result.data.items[].physical_addresses[].street_address`	`string`	No	—	—
`result.data.items[].physical_addresses[].type`	`string`	No	—	—
`result.data.items[].web_pages`	`array`	Yes	—	—
`result.data.items[].web_pages[].url`	`string`	Yes	—	—
`result.data.items[].web_pages[].type`	`string`	No	—	—
`result.data.items[].groups`	`array`	Yes	—	—
`result.data.items[].groups[].id`	`string`	Yes	—	—
`result.data.cursor`	`unknown \| null`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation