A user's Contacts are the list of both users and groups that can be used for "autocompletion" when contacting a User or Group.

Properties

  • current_dropbox_id - (write-only)
  • current_group_id - (write-only)
  • current_workspace_id - (required on create)
  • direct_member - (read-only, included in response only when a current_*_id query parameter is provided)
  • email - (included in response only when source_type is "user")
  • id - (read-only)
  • member - (read-only, included in response only when a current_*_id query parameter is provided)
  • name - (read-only)
  • source_id - (read-only) The ID of the User or Group
  • source_type - (read-only) Either "user" or "group"
  • current_dropbox_id - If a Contact Resource is in this workspace, member will be true. Do not use with other current_*_id.
  • current_group_id - If a Contact Resource is in this group, member will be true. Do not use with other current_*_id.
  • current_workspace_id - If a Contact Resource is in this workspace, member_of_current_workspace will be true
  • email
  • embed%5B%5D=source
  • first_name
  • last_name
  • name
  • q - searches contacts starting with the given string on name, email, first name, and last name

GET and POST

This collection resource contains all of the logged-in user&39;s contacts and all of the visible contacts from the organization or workspace.

Examples

GET /contacts
200 Ok
[
  {
    "name":"Jane Doe",
    "email":"jane@asperasoft.com",
    "source_id":"4",
    "source_type":"user"
  }
]
GET /contacts?current_workspace_id=4&q=a
200 Ok
[
  {
    "id": "33",
    "name": "Sales Group",
    "member_of_current_workspace": false,
    "source_type": "group",
    "source_id": "120"
  },
  {
    "id": "39",
    "name": "Andy Baulti",
    "first_name": "Andy",
    "last_name": "Baulti",
    "email": "abaulti@example.com",
    "member_of_current_workspace": true,
    "source_type": "user",
    "source_id": "13"
  },
  {
    "id": "41",
    "name": "Carl Daimlu",
    "first_name": "Carl",
    "last_name": "Daimlu",
    "email": "cdaimlu@example.com",
    "member_of_current_workspace": false,
    "source_type": "user",
    "source_id": "18"
  }
]

Creating a new contact for a user that may or may not exist in the organization:

POST /contacts
{
  "current_workspace_id": "4",
  "email": "newuser@example.com"
}
200 Ok
{
  "name":"newuser@example.com",
  "email":"newuser@example.com",
  "source_id":"27",
  "source_type":"user"
}
Video player

Video

×

Reset your Password Password resets are handled on the Support Site

×