developers API Documentation

In order to manipulate (create/update/delete) teams, you must use the API key of an account admin.

Team Attributes

Name Type Default value Example Description
id integer auto-incremented 158 The unique id of the team
name string Sales The name of the team
parent_id integer 14 The id of the parent team
created_at datetime Timestamp when the team was created 2018-01-13 11:47:15 (time zone is user's time zone) Timestamp for when the team was created
updated_at datetime Timestamp when the team was updated 2018-01-14 14:12:05 (time zone is user's time zone) Timestamp for when the team was last touched
permissions object See Team Permission section below Object defining team permissions for deals, companies and people

Team Permissions

Team Permissions define visibility level for deals, companies and people for team members and team leads. A default document looks like this:

"permissions" : {
    "document" : {
      "member" : {
        "deal" : {
          "visibility_level" : "owner"
        },
        "company" : {
          "visibility_level" : "owner"
        },
        "person" : {
          "visibility_level" : "owner"
        }
      },
      "*" : {
        "person" : {
          "use_deal_association" : false
        }
      }
    }
  }

Visibility level allows you to control what users in a given team can see and edit and can take one of the following values:
Visibility Level Description
owner Returns user data only
member Returns user data and data of other team members from a user's team
lead Returns user data, data of other team members and data of team leads from a user's team
account Returns global data, without any restrictions.

The last use_deal_association field is not used at this moment.

Please log in to your account to see fantastic examples of our API in action!