List Contacts

Retrieve a list of contacts for the organization.

Note: Maximum 60 requests per minute are allowed.

For more information about the required permissions refer to Access Control.

External Documentation

To learn more, visit the Pylon documentation.

Parameters

Parameter	Description
Cursor	The pagination token used to specify the next page of results. Can be obtained from the pagination.cursor property from a previous response.
Limit	The maximum number of results to return per page. The valid range is 1 - 999.
Return All Pages	Automatically fetch all resources, page by page.

Example Output

{
	"data": [
		{
			"account": {
				"id": "text"
			},
			"avatar_url": "text",
			"custom_fields": {
				"ANY_ADDITIONAL_PROPERTY": {
					"slug": "text",
					"value": "text",
					"values": [
						"text"
					]
				}
			},
			"email": "text",
			"emails": [
				"text"
			],
			"external_ids": [
				{
					"external_id": "text",
					"label": "text"
				}
			],
			"id": "text",
			"integration_user_ids": [
				{
					"id": "text",
					"source": "text"
				}
			],
			"name": "text",
			"phone_numbers": [
				"text"
			],
			"portal_role": "no_access",
			"portal_role_id": "text",
			"primary_phone_number": "text"
		}
	],
	"pagination": {
		"cursor": "text",
		"has_next_page": true
	},
	"request_id": "text"
}

Workflow Library Example

List Contacts with Pylon and Send Results Via Email

Preview this Workflow on desktop