activities

List all activities.

Create a new activity.

Retrieve an activity

Update an activity

Delete an activity

activity-types

List all activity types

Create an activity type

Retrieve an activity type

Update an activity type

Delete an activity type

apps

Uninstall an app

Update an app setting

companies

List all companies

Create a new company

Retrieve a company

Update a company

Delete a company

Duplicates a company

contacts

List all contacts

Create a new contact

Retrieve a contact

Update a contact

Delete a contact

Duplicates a contact

countries

List all countries

Retrieve a country

currencies

List all currencies

Retrieve a currency

custom-fields

List all custom fields

Create a new custom field

Update a custom field

Delete a custom field

Retrieve a custom field

deals

Create a new deal

Retrieve a deal

Duplicates a deal

exports

List all exports

Create a new export

files

Download a file

Redirect to file

Attach an uploaded file to an entity

imports

List all imports

lost-reasons

List all lost reasons

Create a new lost reason

Retrieve a lost reason

Update a lost reason

Delete a lost reason

notes

Create a new note

Retrieve a note

phone-codes

List all phone codes

pipelines

Delete a pipeline

List all pipelines

Create a new pipeline

Retrieve a pipeline

Update a pipeline

products

List all products

Create a new product

Retrieve a product

Update a product

Delete a product

search

Search text in entities

search-filters

Search for filters

stages

List all stages

Create a new stage

Retrieve a stage

timezones

List all timezones

Retrieve a timezone

users

Retrieve current user

Retrieve a user

Updates a user and returns it

webhook-events

List all webhook events

webhook-requests

List all webhook requests

Retrieve a webhook request

Redeliver a webhook-request

webhooks

List all webhooks

Create a new webhook

Retrieve a webhook

Update a webhook

Delete a webhook

won-reasons

List all won reasons

Create a new won reason

Retrieve a won reason

Update a won reason

Delete a won reason

Models

AccountUnreadCounts

ActivityReminder

AgePagedReportMeta

AgeReportWithIncludes

ConversionMetrics

ConversionPagedReportMeta

ConversionReportData

ConversionReportWithIncludes

ConversionState

ConversionStates

CreatePipelineRequest

CustomFieldValue

CustomFilterColumn

CustomFilterCondition

DealPagedReportMeta

DealProjectsData

DealReportMetaStatus

DealReportMetaStatuses

DealReportStatus

DealReportStatuses

DealReportWithIncludes

EmailConnection

EmailPagedReportMeta

EmailParticipant

EmailProviderSettings

EmailReportData

EmailReportWithIncludes

FeatureAnnouncement

FileUploadRequest

FileUploadRequestFile

ForeignItemLink

ForeignItemLinkCounts

ImportsListResponse

InstallationSettings

ListResponseMeta

OvertimeReportData

OvertimeReportDataMeta

OvertimeReportWithIncludes

PatchPipelineRequest

PipelineResponse

PipelinesResponse

ResourceIdentifier

ResourceIdentifierRequest

SearchableEntity

VelocityPagedReportMeta

VelocityReportAge

VelocityReportAges

VelocityReportData

VelocityReportWithIncludes

VelocityStageReportAge

activitiesListResponse

activitiesResponse

activityPositionResponse

activityResponse

activityTypeResponse

activityTypesResponse

bulkUpdateActivityRequestWithOptions

bulkUpdateCompanyFollowers

bulkUpdateCompanyFollowersRequest

bulkUpdateCompanyRequestWithOptions

bulkUpdateContactFollowers

bulkUpdateContactFollowersRequest

bulkUpdateContactRequestWithOptions

bulkUpdateDealFollowers

bulkUpdateDealFollowersRequest

bulkUpdateDealRequestWithOptions

bulkUpdateEmailThreadsRequest

bulkUpdateMailboxes

bulkUpdatePipelineFollowers

bulkUpdatePipelineFollowersRequest

bulkUpdateProductRequestWithOptions

bulkUpdateResponse

bulkUpdateRetryRequest

bulkUpdateUserRequestWithOptions

companiesListResponse

companiesResponse

companyFollowerRequest

companyFollowerResponse

companyFollowersResponse

companyPositionResponse

companyResponse

completeInviteRequest

connectEmailRequest

connectMessageResponse

connectToManyMessageResponse

contactFollowerRequest

contactFollowerResponse

contactFollowersResponse

contactPositionResponse

contactResponse

contactsListResponse

contactsResponse

countriesResponse

countryResponse

createActivityRequest

createActivityTypeRequest

createAndConnectMessageRequest

createCompanyRequest

createContactRequest

createCustomFieldRequest

createCustomFilterRequest

createDealRequest

createDraftRequest

createExportRequest

createLostReason

createLostReasonRequest

createMessageRequest

createNoteRequest

createProductRequest

createStageRequest

createWebhookRequest

createWonReason

createWonReasonRequest

createdFilesResponse

currenciesResponse

currencyResponse

customFieldResponse

customFieldsResponse

customFilterColumnRequest

customFilterConditionRequest

customFilterResponse

customFiltersResponse

dealFollowerRequest

dealFollowerResponse

dealFollowersResponse

dealPositionResponse

dealResponseMeta

dealsListResponse

deleteDraftRequest

deleteEmailThreadsRequest

disconnectDealForeignLinksRequest

duplicateContactRequest

emailAccountResponse

emailAccountsResponse

emailConnectionRequest

emailConnectionResponse

emailConnectionsResponse

emailContactMetaResponse

emailContactResponse

emailCreateManyConnectionsRequest

emailCreateManyConnectionsResponse

emailDraftResponse

emailDraftsResponse

emailMessageResponse

emailMessagesRequest

emailProvidersResponse

emailThreadResponse

exportsResponse

featureAnnouncementsResponse

feedbackRequest

forecastResponse

installationSettingsResponse

lostReasonResponse

lostReasonsResponse

mailboxResponse

mailboxesResponse

messagesResponse

patchActivityRequest

patchActivityTypeRequest

patchCompanyRequest

patchContactRequest

patchCustomFieldRequest

patchCustomFilterRequest

patchDealRequest

patchDraftRequest

patchEmailAccount

patchEmailAccountRequest

patchEmailMessageRequest

patchEmailThreadRequest

patchFileRequest

patchInstallationSettingsRequest

patchLostReason

patchLostReasonRequest

patchMailboxRequest

patchNoteRequest

patchProductRequest

patchStageRequest

patchUserRequest

patchWebhookRequest

patchWonReasonRequest

phoneCodesResponse

pipelineBoardMetaResponse

pipelineBoardResponse

pipelineFollowerRequest

pipelineFollowerResponse

pipelineFollowersResponse

productResponse

productsListResponse

productsResponse

searchableResponse

sendDraftRequest

sessionResponse

subscriptionURLSResponse

syncJobResponse

threadsResponse

timezoneResponse

timezonesResponse

trashCanItemsResponse

unreadCountResponse

unreadInboxCountResponse

updateAppSettingRequest

uploadEmailFileRequest

uploadEmailFileResponse

userPositionResponse

userStateResponse

usersListResponse

webhookEventsMeta

webhookEventsResponse

webhookRequestResponse

webhookRequestsResponse

webhookResponse

webhooksResponse

wonReasonResponse

wonReasonsResponse

Powered by Stoplight

EmailProvider

EmailProvider that a user can connect to.

object

code

string

id

integer

isEnabled

boolean

logo

string

name

string

settings

object

EmailProviderSettings defines additional provider specific settings.