Developer
v2
Sign In with Github
Sign In with Github
Overview
Getting started
Authentication
Reading from the API
Writing to the API
Handling API responses
Avoid polling with REST hooks
Announcements and changes
Third party tools
Support and discussion
Discussion
Party
List parties
Show party
Show multiple parties
Create party
Update party
Delete party
List employees
List deleted parties
Search parties
Opportunity
List opportunities
List opportunities by party
Show opportunity
Show multiple opportunities
Create opportunity
Update opportunity
Delete opportunity
List deleted opportunities
Search opportunities
List additional parties
Add additional party
Remove additional party
List associated projects
Case
Overview
Project
List projects
List projects by party
Show project
Show multiple projects
Create project
Update project
Delete project
List deleted projects
Search projects
List additional parties
Add additional party
Remove additional party
Task
List tasks
Show task
Create task
Update task
Delete task
Entry
List entries
List by date
Show entry
Create entry
Update entry
Delete entry
Upload attachment
Show attachment
Filter
Run query
Track
List tracks
Show track
Create track
Update track
Delete track
Site
Show site address
User
List users
Show current user
Show user
Update user
Team
List teams
Show team
Tag
List tag definitions
Show tag definition
Create tag definition
Update tag definition
Delete tag definition
Custom Field
List custom fields
Show custom field
Create custom field
Update custom field
Delete custom field
Pipeline
List pipelines
Show pipeline
Show multiple pipelines
Create pipeline
Duplicate pipeline
Update pipeline
Archive pipeline
Restore pipeline
Milestone
List milestones
List milestones by pipeline
Show milestone
Create milestone
Update milestone
Delete milestone
Lost Reason
List lost reasons
Show lost reason
Create lost reason
Update lost reason
Delete lost reason
Board
List boards
Show board
Create board
Update board
Archive board
Restore board
Stage
List stages
List stages by board
Show stage
Create stage
Update stage
Delete stage
REST Hook
List REST hooks
Show REST hook
Subscribe REST hook
Unsubscribe REST hook
Track Definition
List track definitions
Show track definition
Create track definition
Update track definition
Delete track definition
Category
List task categories
Show task category
Create task category
Update task category
Delete task category
Activity Type
List activity types
Show activity type
Create activity type
Update activity type
Delete activity type
List icons
Internationalization
List countries
List currencies
Custom Title
List custom titles
Create custom title
Delete custom title
Overview
Getting started
Authentication
Reading from the API
Writing to the API
Handling API responses
Avoid polling with REST hooks
Announcements and changes
Third party tools
Support and discussion
Core Resources
Party
List parties
Show party
Show multiple parties
Create party
Update party
Delete party
List employees
List deleted parties
Search parties
Opportunity
List opportunities
List opportunities by party
Show opportunity
Show multiple opportunities
Create opportunity
Update opportunity
Delete opportunity
List deleted opportunities
Search opportunities
List additional parties
Add additional party
Remove additional party
List associated projects
Case
Overview
Project
List projects
List projects by party
Show project
Show multiple projects
Create project
Update project
Delete project
List deleted projects
Search projects
List additional parties
Add additional party
Remove additional party
Task
List tasks
Show task
Create task
Update task
Delete task
Entry
List entries
List by date
Show entry
Create entry
Update entry
Delete entry
Upload attachment
Show attachment
Filter
Run query
Track
List tracks
Show track
Create track
Update track
Delete track
Settings Resources
Site
Show site address
User
List users
Show current user
Show user
Update user
Team
List teams
Show team
Tag
List tag definitions
Show tag definition
Create tag definition
Update tag definition
Delete tag definition
Custom Field
List custom fields
Show custom field
Create custom field
Update custom field
Delete custom field
Pipeline
List pipelines
Show pipeline
Show multiple pipelines
Create pipeline
Duplicate pipeline
Update pipeline
Archive pipeline
Restore pipeline
Milestone
List milestones
List milestones by pipeline
Show milestone
Create milestone
Update milestone
Delete milestone
Lost Reason
List lost reasons
Show lost reason
Create lost reason
Update lost reason
Delete lost reason
Board
List boards
Show board
Create board
Update board
Archive board
Restore board
Stage
List stages
List stages by board
Show stage
Create stage
Update stage
Delete stage
REST Hook
List REST hooks
Show REST hook
Subscribe REST hook
Unsubscribe REST hook
Track Definition
List track definitions
Show track definition
Create track definition
Update track definition
Delete track definition
Category
List task categories
Show task category
Create task category
Update task category
Delete task category
Activity Type
List activity types
Show activity type
Create activity type
Update activity type
Delete activity type
List icons
Internationalization
List countries
List currencies
Custom Title
List custom titles
Create custom title
Delete custom title
Models
Party
Opportunity
Case
Project
Filter
Task
Entry
Track
Track Definition
User
Team
Site
Tag Definition
Field Definition
Pipeline
Milestone
Lost Reason
Board
Stage
Activity Type
REST Hook
Category
Country
Currency
Attachment
Title
Nested Team Model
Represents a reference to a team.
Name
Type
Description
id
Long
Read only
The unique id of this team.
name
String
The name of the team.
