Sign in

v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB
Contacts

Query Contacts

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

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

get/contacts

Query parameters

meboolean

If present - only contact info of requesting user is returned

If present - only contact info of requesting user is returned

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

deletedboolean

Deleted flag filter

Deleted flag filter

Custom field filter

Email contacts filter. Limit : 100

activeboolean

Active status filter

Active status filter

namestring

Contact name filter

Contact name filter

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

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

Response

success response

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'