Back to FrontList contacts
List the contacts of the company.
Input
type: object
properties:
parameters:
type: object
properties:
q:
type: string
description: >-
Search query object with the optional properties `updated_after` and
`updated_before`, whose value should be a timestamp in seconds with up
to 3 decimal places.
limit:
type: number
description: Max number of results per page
page_token:
type: string
description: Token to use to request the next page
sort_by:
type: string
description: Field used to sort the records
sort_order:
type: string
description: Order by which results should be sorted
title: Parameters
Output
type: object
properties:
_pagination:
type: object
properties:
next:
type: string
_links:
type: object
properties:
self:
type: string
_results:
type: array
items:
type: object
properties:
_links:
type: object
properties:
self:
type: string
related:
type: object
properties:
notes:
type: string
conversations:
type: string
owner:
type: string
id:
type: string
name:
type: string
description:
type: string
avatar_url:
type: string
is_spammer:
type: boolean
links:
type: array
items:
type: string
groups:
type: array
items:
type: object
properties:
_links:
type: object
properties:
self:
type: string
related:
type: object
properties:
contacts:
type: string
owner:
type: string
id:
type: string
name:
type: string
is_private:
type: boolean
handles:
type: array
items:
type: object
properties:
handle:
type: string
source:
type: string
custom_fields:
type: object
is_private:
type: boolean