List contacts with the Zendesk Sell API

Lists the contacts the user can see, people and organizations, filtered by the arguments given, 25 per page by default. Each item has the record in data, and meta.count says how many came in the page. Page through with page and per_page.

Identifier
zendesk_sell_list_contacts

The request

POST https://connect.reportei.com/api/tools/zendesk_sell_list_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "ids": "<ids>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
idsstringNoComma-separated ids of the contacts to return, for example 1,2,3, from List contacts or Create contact.
is_organizationbooleanNotrue returns only organizations, false only people.
contact_idintegerNoId of an organization contact, from List contacts, to return the people who work for it.
owner_idintegerNoId of the user who owns the contacts, from List users.
namestringNoName of an organization contact.
first_namestringNoFirst name of a person.
last_namestringNoLast name of a person.
emailstringNoEmail address of the contact.
customer_statusstringNoCustomer status.Values: none, current, past
prospect_statusstringNoProspect status.Values: none, current, lost
sort_bystringNoField to sort by: id, name, first_name, last_name, email, created_at or updated_at. Append :desc for descending order, for example last_name:desc.
pageintegerNoPage number, starting at 1.
per_pageintegerNoContacts per page, up to 100. The default is 25.

Supported connections

Your customer connects their Zendesk Sell account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/zendesk_sell, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/zendesk_sell_list_contacts. It becomes your agent's tool definition with no conversion.

Other Zendesk Sell tools

See all 14 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.