Collaborations

The Collaborations API provides a simple interface to manage collaborations. The API allows you to create and delete your collaborations. You can retrieve a single collaboration as well as list of all collaborations.

You can assign as many collaborations as you want to any of the resources listed below:

Properties

Attribute Description
id number readonly

Unique identifier of the collaboration.

creator_id number readonly

Unique identifier of the user that created the collaboration.

resource_type string

Type name of the resource the collaboration is attached to.

Possible values:

  • lead
  • contact
  • sales_account
  • deal
resource_id number

Unique identifier of the resource the collaboration is attached to.

collaborator_id number

Unique identifier of the collaborator.

created_at string readonly

Date and time of creation in UTC (ISO8601 format).

updated_at string readonly

Date and time of the last update in UTC (ISO8601 format).


Endpoints


Retrieve all collaborations

Returns all collaborations available to the user, according to the parameters provided.

Parameters

Attribute Description
page number optional

Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.

e.g. ?page=2
per_page number optional

Number of records to return per page. The default limit is 25 and the maximum number that can be returned at one time is 100.

e.g. ?per_page=20
sort_by string optional

A field to sort by. Default ordering is ascending. If you want to change the sort ordering to descending, append :desc to the field e.g. sort_by=resource_type:desc.

Possible values:

  • id
  • resource_type
  • created_at
  • updated_at
e.g. ?sort_by=created_at
includes string optional

Comma-separated list of one or more resources related to the collaboration. Not supported at the moment.

ids string optional

Comma-separated list of collaboration IDs to be returned in a request.

e.g. ?ids=1,2,3
creator_id number optional

Unique identifier of the user. Returns all collaborations created by the user.

e.g. ?creator_id=1
resource_type string optional

Name of the type of resource to search for.

Possible values:

  • lead
  • contact
  • sales_account
  • deal
e.g. ?resource_type=lead
resource_id number optional

Unique identifier of the resource to search for.

e.g. ?resource_id=1

Create a collaboration

Create a new collaboration and associate it with one of the resources listed below:

Parameters

Attribute Description
resource_type string required
e.g. "resource_type": "lead"
resource_id number required
e.g. "resource_id": "1"
collaborator_id number required
e.g. "collaborator_id": "2"

Retrieve a single collaboration

Returns a single collaboration available to the user, according to the unique collaboration ID provided. If the collaboration ID does not exist, this request will return an error.

Parameters

Attribute Description
id number required

Unique identifier of the collaboration.


Delete a collaboration

Delete an existing collaboration. If the collaboration ID does not exist, this request will return an error. This operation cannot be undone.

Parameters

Attribute Description
id number required

Unique identifier of the collaboration.