Query Contacts

get

https://www.wrike.com/api/v4/contacts

List contacts of all users and user groups in current account.

Scopes: Default, wsReadOnly, wsReadWrite

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

boolean

If present - only contact info of requesting user is returned

metadata

object

Metadata filter, exact match for metadata key or key-value pair

deleted

boolean

Deleted flag filter

customFields

array of objects

Custom field filter

customFields

emails

array of strings

length ≤ 100

Email contacts filter. Limit : 100

emails

active

boolean

Active status filter

name

string

Contact name filter

types

array of strings

Contact type filter

Group - Group of users. Group userId can be used in folder/task sharing requests only. It has no effect in other operations
Asset - Asset
Person - Person
Robot - Robot user for automated operations

types

fields

array of strings

Json string array of optional fields to be included in the response model

metadata - Contact metadata
currentCostRate - Current user's cost rate
customFields - User's custom fields
currentBillRate - Current user's bill rate
jobRoleId - Current user's jobRoleId
workScheduleId - Contact work schedule id

fields

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

2XXsuccess response

4XXclient-side error response

5XXserver-side error response