Back to Teamwork CRMList all contacts
Returns a list of contacts, they are returned sorted by name by default.
The following values are allowed in the include query parameter:
- avatar
- company.country
- country
- owner.avatar
The following targets are allowed in filter query parameters:
- companyExists
- companyId
- createdAt
- dealId
- email
- id
- name
- updatedAt
The following values are allowed in the sort query parameter:
- address
- country
- createdAt
- firstName
- lastName
- mainEmail
- mainPhone
- name (default)
- updatedAt
Input
type: object
properties:
parameters:
type: object
properties:
orderMode:
type: string
default: asc
enum:
- asc
- desc
description: Which direction to order the results in.
orderBy:
type: string
description: >-
The sorting which the items are returned with, see the endpoints
documentation
for supported values and [sorting](/crm/general/sorting)
for more detailed documentation of how this works.
include:
type: string
description: |-
Comma separated list of relationships to include in the response.
See
[including related entities](/crm/general/related-entities)
for more detailed documentation of how this works.
pageSize:
maximum: 200
minimum: 1
type: integer
default: 20
description: >-
Max number of items per page
See [pagination](/crm/general/pagination) for more detailed
documentation of how this works.
pageOffset:
type: integer
default: 0
description: >-
Offset items in the page by amount. For example with a pageSize of 20
setting pageOffset to 20 will return the next page.
See [pagination](/crm/general/pagination) for more detailed
documentation of how this works.
title: Parameters
Output
type: object
title: contactsResponse
properties:
contacts:
type: array
items:
type: object
title: Contact
properties:
addressLine1:
type: string
addressLine2:
type: string
avatar:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
city:
type: string
company:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
country:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
createdAt:
type: string
description: When the item was created, as a datetime
format: date-time
createdBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
custom:
type: object
deletedAt:
type: string
description: When the item was deleted, as a datetime
format: date-time
deletedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
duplicatedFrom:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "deals".
emailAddresses:
type: array
items:
type: object
properties:
address:
type: string
format: email
isMain:
type: boolean
description: One element in the array must have this set to true.
firstName:
type: string
id:
type: integer
lastName:
type: string
owner:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
phoneNumbers:
type: array
items:
type: object
properties:
code:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- phone-codes
isMain:
type: boolean
description: One element in the array must have this set to true.
number:
type: string
description: >-
The phone number, excluding the country code (this can be
specified with `code`).
stateOrCounty:
type: string
timezone:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
title:
type: string
updatedAt:
type: string
description: When the item was last updated, as a datetime
format: date-time
updatedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
updatedSourceId:
type: integer
description: Source ID of the latest request made (API / Web app)
zipcode:
type: string
included:
type: object
title: Included
meta:
type: object
title: ResponseMeta
properties:
page:
type: object
title: Page
properties:
count:
type: integer
pageOffset:
type: integer
pageSize:
type: integer