Kapta Developer Documentation

Welcome to the Kapta API Developer Documentation! A license is required to use the API. If you are interested in obtaining a license or have any questions about the API, please contact support@kapta.com.

Once your company is licensed to use the API, your admin users are able to create application keys using the system's admin mode. For more information about creating application keys, visit the API Applications documentation.

Access to all API resources requires an OAuth token be provided in the Authorization header of the request. For more information on obtaining a token for a user, visit the OAuth 2.0 or REST Logon documentation.

The following resources are available to authenticated users:

Accounts

API	Description
GET v1/accounts	Gets a list of all accounts for the authenticated user
GET v1/accounts?include_archived={include_archived}	Gets a list of all accounts for the authenticated user
GET v1/rolebasedaccounts	Gets a list of all role-based accounts for the authenticated user
GET v1/account/{id}	Gets an specified account
GET v1/accounts/metric	Get All Account Metrics
GET v1/accounts/metric/{date}	Get All Account Metrics by date
GET v1/account/{id}/metrics	Get the Metrics for a specified Account
GET v1/accounts/stats	Get Current Person Account Stats
GET v1/account/{id}/contracts	Get the Contracts for a specified Account
GET v1/account/{id}/opportunities	Get the Opportunities for a specified Account
GET v1/account/{id}/notes	Get the Notes for a specified Account
GET v1/account/{id}/products	Get the Products for a specified Account
GET v1/account/{id}/actionplan	Get the Action Plan for a specified Account (Goals, Objecties, and Actions)
GET v1/account/{id}/contributors	Get the Contributors for a specified Account
POST v1/account	Creates a new account for the authenticated user
PUT v1/account/{id}	Update the account for the authenticated user
PUT v1/account/{id}/parent	Update the account parent for the authenticated user
PUT v1/account/metric	Update a specified account Metric
POST v1/account/{id}/note	Creates a new account note for the authenticated user
PUT v1/account/{id}/note/{noteid}	Update an account note for the authenticated user
POST v1/account/{id}/contract	Creates a new account contract for the authenticated user
PUT v1/account/{id}/contract/{contractid}	Update an account contract for the authenticated user
POST v1/account/{id}/opportunity	Creates a new account opportunity for the authenticated user
PUT v1/account/{id}/opportunity/{opportunityid}	Update an account opportunity for the authenticated user
PUT v1/account/{id}/product/{productid}	Assign a product to the specified account
DELETE v1/account/{id}/product/{productid}	Remove the product from the specified account

AccountTasks

Account tasks are a to do list for the account

API	Description
POST v1/account/{accountid}/tasks	Creates a new task for the specified account
GET v1/account/{accountid}/tasks/{typefilter}	Gets a list of tasks for the specified account
GET v1/account/{accountid}/task/{id}	Gets information about the specified task
PUT v1/account/{accountid}/task/{id}	Modifies task information
PUT v1/account/{accountid}/task/{id}/complete	Marks the specified task as completed

Company

API	Description
GET v1/company	Get your current Company information
PUT v1/company	Update your company information

Contacts

API	Description
GET v1/contacts	Gets a list of all contacts for the authenticated user
POST v1/contactsbyaccounts	Gets a list of all contacts the specified list of account IDs
GET v1/contactsreportsto/{accountid}	Gets a list of all reports-to contacts for the specified account ID
POST v1/contacts	Creates a new contact for the authenticated user
PUT v1/contact/{id}	Update the contact for the authenticated user.
PUT v1/accountcontact/{id}	Update the account contact for the authenticated user.

ContractsOpportunities

API	Description
GET v1/contracts	Gets a list of all contracts for the authenticated user
GET v1/opportunities	Gets a list of all opportunities for the authenticated user (Only available if feature is enabled)

GoalNotes

A note allows users to add information about the current status of a goal.

API	Description
POST v1/goals/{goalid}/notes	Creates a new note for the specified goal
GET v1/goals/{goalid}/notes	Gets a list of all notes for the specified goal
GET v1/goals/{goalid}/notes/{id}	Gets information about the specified note
DELETE v1/goals/{goalid}/notes/{id}	Deletes the specified note

Goals

A goal is a commitment to action that a user has made. Each goal contributes to the success of an objective.

API	Description
GET v1/goals/statuses	Gets a list of valid goal status options
POST v1/person/goals	Creates a new goal for the authenticated user
POST v1/person/{personid}/goals	Creates a new goal for the specified user (scope: manager or administrator)
GET v1/person/goals	Gets a list of all goals for the authenticated user
GET v1/person/{personid}/goals	Gets a list of all goals for the specified user (scope: manager or administrator)
GET v1/person/goals/{id}	Gets information about the specified goal
GET v1/person/{personid}/goals/{id}	Gets information about the specified goal (scope: manager or administrator)
PUT v1/person/goals/{id}	Modifies information about a goal
PUT v1/person/{personid}/goals/{id}	Modifies information about a goal (scope: manager or administrator)
PUT v1/person/goals/{id}/complete	Marks the specified goal as completed
PUT v1/person/{personid}/goals/{id}/complete	Marks the specified goal as completed (scope: manager or administrator)
PUT v1/person/goals/{id}/reopen	Re-Opens a previously completed goal
PUT v1/person/{personid}/goals/{id}/reopen	Re-Opens a previously completed goal (scope: manager or administrator)
DELETE v1/person/goals/{id}	Deletes the specified goal
DELETE v1/person/{personid}/goals/{id}	Deletes the specified goal (scope: manager or administrator)

GoalTasks

A task is one of the steps necessary to complete a goal.

API	Description
POST v1/goals/{goalid}/tasks	Creates a new task for the specified goal
GET v1/goals/{goalid}/tasks	Gets a list of all tasks for the specified goal
GET v1/goals/{goalid}/tasks/{id}	Gets information about the specified task
PUT v1/goals/{goalid}/tasks/{id}	Modifies task information
PUT v1/goals/{goalid}/tasks/{id}/complete	Marks the specified task as completed
PUT v1/goals/{goalid}/tasks/{id}/reopen	Re-Opens a previously completed task
DELETE v1/goals/{goalid}/tasks/{id}	Deletes the specified task

Me

API	Description
GET v1/me	Gets the email of the current user

Notes

API	Description
GET v1/notesubtypes	Gets a list of all note sub types for the authenticated user

Objectives

An objective specifies the intended direction of a company or team. They can be long term, like a value or belief, or they can be specific with a due date.

API	Description
GET v1/person/objectives	Gets a list of all objectives under which the authenticated user can create goals
GET v1/person/{id}/objectives	Gets a list of all objectives under which the specified person can create goals (scope: manager or administrator)

Persons

A person is any individual in the system.

API	Description
GET v1/persons	Gets a list of all people in your company in the system
GET v1/person?email={email}	Get a person by email address
POST v1/persons/person	Creates a new user for the authenticated user

Products

Products that can be assigned to Accounts

API	Description
GET v1/products	Gets a list of all products for the authenticated user
GET v1/product/{id}	Gets an specified product info
POST v1/product	Creates a new product for the authenticated user
PUT v1/product/{id}	Update a product for the authenticated user

QBRs

API	Description
GET v1/qbrs/{qbrtypeid}	Gets a list of the current QBR status for each account
GET v1/{accountid}/qbrs/{qbrtypeid}	Gets a detailed list of QBRs for the specified account
GET v1/qbrs/types	Gets a list of all QBR Types