Query Contacts

List contacts of specified users and user groups.

Scopes: Default, wsReadOnly, wsReadWrite

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
contactIds
array
required
length ≤ 1000

Comma-separated list of ids. Limit : 1000

contactIds*
Query Params
metadata
object

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json