---
title: "Query Contacts"
method: GET
path: "/contacts"
tags: ["Contacts"]
---

# Query Contacts

`GET /contacts`

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

<b>Scopes:</b> Default, wsReadOnly, wsReadWrite

## Query parameters

- `me` boolean — If present - only contact info of requesting user is returned
- `deleted` boolean — Deleted flag filter
- `active` boolean — Active status filter
- `name` string — Contact name filter

## Response `2XX`

success response

- object
  - `data` Contact[]
    - `lastName` string — Last name
    - `metadata` Metadata[] — List of contact metadata entries. Requesting user has read/write access to his own metadata, other entries are read-only
      - `value` string, required — Value should be less than 1000 symbols, compatible with JSON string. Use JSON 'null' in order to remove metadata entry
      - `key` string, required — Key should be less than 50 symbols and match following regular expression ([A-Za-z0-9_-]+)
    - `avatarUrl` string — Avatar URL
    - `timezone` string — Timezone Id, e.g 'America/New_York'
    - `currentCostRate` BudgetRate
      - `rateValue` number — Rate value is displayed to 2 decimal places. More digits will be rounded arithmetically to 2 decimal places. No need to specify rate value if rate source is "job role"
      - `rateScope` 'Account' | 'Project' — * `Account` * `Project`
      - `rateSource` 'JobRole' | 'User', required — * `JobRole` * `User`
    - `customFields` CustomField[] — Custom fields
      - `id` string, required
      - `value` string, required — Custom field value. 4000 characters max. Should be valid string according to JSON RFC 8259. In particular, following characters must be escaped: quotation mark, reverse solidus, and the control characters (U+0000 through U+001F). Any character may be escaped, but unnecessarily escaped character can be implicitly translated to it's unescaped version. <br> In addition to RFC 8259 requirements, it is not recommended to use any of control characters in CF value.<br>Wrike's API forbids using U+0000 in every place and U+0011 at the beginning of the CF value string.<br>The correct way for setting multiple values in the multiple select Custom fields is ?customFields=[{"id":"CustomFieldId","value":"[\"value1\",\"value2\"]"}]<br>The correct way for setting values in the people Custom fields is ?customFields=[{"id":"CustomFieldId","value":"UserId1, UserId2"}]<br> Note that if custom field values are passed to API as URI param of request, they must be URI encoded. Here are some examples:<br>"%5c" - reverse solidus (backslash)<br>"%5c%22" - quotation mark<br>"Vi%5Cu1ec7t" - unicode-escaped character in word "Việt"<br>
    - `companyName` string — User Company Name
    - `profiles` UserProfile[] — List of user profiles in accounts accessible for requesting user
      - `owner` boolean, required — Is user account owner
      - `accountId` string, required
      - `external` boolean, required — Is user external
      - `role` 'User' | 'Collaborator', required — * `User` * `Collaborator`
      - `admin` boolean, required — Is user account admin
      - `active` boolean, required — Is user active in account
      - `email` string, required — Email address associated with account
    - `type` 'Group' | 'Asset' | 'Person' | 'Robot'
    - `locale` string — Locale
    - `title` string — User Title
    - `firstName` string — First name
    - `deleted` boolean — True if user is deleted, false otherwise
    - `phone` string — User phone
    - `currentBillRate` BudgetRate
      - `rateValue` number — Rate value is displayed to 2 decimal places. More digits will be rounded arithmetically to 2 decimal places. No need to specify rate value if rate source is "job role"
      - `rateScope` 'Account' | 'Project' — * `Account` * `Project`
      - `rateSource` 'JobRole' | 'User', required — * `JobRole` * `User`
    - `me` boolean — Field is present and set to true only for requesting user
    - `myTeam` boolean — Field is present and set to true for My Team (default) group
    - `jobRoleId` string
    - `location` string — User location
    - `workScheduleId` string
    - `id` string
    - `memberIds` UserId[] — List of group members contact IDs (field is present only for groups)
    - `primaryEmail` string — Primary Email
  - `kind` 'accounts' | 'users' | 'contacts' | 'assets' | 'eDiscoveryReport' | 'folders' | 'folderTree' | 'tasks' | 'taskIds' | 'timelogs' | 'timelogCategories' | 'timelogLockPeriods' | 'timetrackerTimers' | 'comments' | 'attachments' | 'url' | 'version' | 'dataExport' | 'dataExportSchema' | 'auditLog' | 'accessRoles' | 'stream' | 'changes' | 'posts' | 'mailSettings' | 'integrationInfo' | 'gmailIntegrationSettings' | 'workTypesForIntegrations' | 'ids' | 'backups' | 'domains' | 'dependencies' | 'workflows' | 'workschedules' | 'workscheduleExclusions' | 'workscheduleUserExclusions' | 'customfields' | 'customfieldIds' | 'customstatuses' | 'invitations' | 'notifications' | 'jobroles' | 'placeholders' | 'groups' | 'session' | 'dashboards' | 'widgets' | 'taskCreationSettings' | 'colors' | 'experiments' | 'topics' | 'topicComments' | 'webhooks' | 'reviews' | 'boards' | 'textSearch' | 'chatChannels' | 'chatMessages' | 'forms' | 'requestForms' | 'request' | 'report' | 'platformWidgets' | 'platformWidgetInstances' | 'spaces' | 'pdf' | 'customerSatisfaction' | 'asyncJob' | 'approvals' | 'highlights' | 'highlightsList' | 'highlightsSettings' | 'highlightsCard' | 'timesheet' | 'timesheetRow' | 'timesheetSubmissionRule' | 'mobileFeatures' | 'mobileSettings' | 'folderBlueprintTree' | 'taskBlueprintTree' | 'feedback' | 'timeline_snapshot' | 'contactIds' | 'bookings' | 'integrateThreshold' | 'hourlyRatesProvision' | 'hourlyRates' | 'projectTeamMembers' | 'contactsHistory' | 'tasksHistory' | 'foldersHistory' | 'activityDigest' | 'workItemTemplates' | 'workTemplates' | 'workItemMetadata' | 'workItem' | 'customItemTypes' | 'verificationCode' | 'views' | 'listView' | 'tableView' | 'userTypes' | 'reactions' | 'externalRequesters' | 'workscheduleCapacityOverrides' | 'userCapacityOverrides' | 'userCapacityExclusions' | 'rollups' | 'requestFormPrefill' | 'userAggregatedCapacity' | 'cascadingFieldSettings'

## Other responses

- `4XX` — client-side error response
- `5XX` — server-side error response

---

[API](https://skmtc.net/wrike/apis/wrike-api.md) · [All operations](https://skmtc.net/wrike/apis/wrike-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wrike/wrike-api/revisions/f1c1279c29d6/schema)