logo
Documentation
API Reference
No results found.
activities
List all activities.
get
Create a new activity.
post
Retrieve an activity
get
Update an activity
patch
Delete an activity
delete
activity-types
List all activity types
get
Create an activity type
post
Retrieve an activity type
get
Update an activity type
patch
Delete an activity type
delete
companies
List all companies
get
Create a new company
post
Retrieve a company
get
Update a company
patch
Delete a company
delete
Duplicates a company
post
contacts
List all contacts
get
Create a new contact
post
Retrieve a contact
get
Update a contact
patch
Delete a contact
delete
Duplicates a contact
post
countries
List all countries
get
Retrieve a country
get
currencies
List all currencies
get
Retrieve a currency
get
custom-fields
List all custom fields
get
Create a new custom field
post
Update a custom field
patch
Delete a custom field
delete
Retrieve a custom field
get
deals
List all deals
get
Create a new deal
post
Disconects foreign item links to a deal
post
Retrieve a deal
get
Update a deal
patch
Delete a deal
delete
Duplicates a deal
post
exports
List all exports
get
Create a new export
post
files
Download a file
get
Redirect to file
get
List all files
get
Attach an uploaded file to an entity
post
Delete files
post
Update a file
patch
Delete a file
delete
imports
List all imports
get
lost-reasons
List all lost reasons
get
Create a new lost reason
post
Retrieve a lost reason
get
Update a lost reason
patch
Delete a lost reason
delete
notes
List all notes
get
Create a new note
post
Retrieve a note
get
Update a note
patch
Delete a note
delete
phone-codes
List all phone codes
get
pipelines
Delete a pipeline
delete
List all pipelines
get
Create a new pipeline
post
Retrieve a pipeline
get
Update a pipeline
patch
products
List all products
get
Create a new product
post
Retrieve a product
get
Update a product
patch
Delete a product
delete
search
Search text in entities
get
search-filters
Search for filters
get
stages
List all stages
get
Create a new stage
post
Retrieve a stage
get
Update a stage
patch
Delete a stage
delete
timezones
List all timezones
get
Retrieve a timezone
get
users
List all users
get
Retrieve current user
get
Retrieve a user
get
Updates a user and returns it
patch
Delete a user
delete
webhook-events
List all webhook events
get
webhook-requests
List all webhook requests
get
Retrieve a webhook request
get
Redeliver a webhook-request
post
webhooks
List all webhooks
get
Create a new webhook
post
Retrieve a webhook
get
Update a webhook
patch
Delete a webhook
delete
Models
Activity
ActivityType
AgePagedReportMeta
AgeReportData
AgeReportWithIncludes
BillingURLs
Company
Contact
ConversionMetrics
ConversionPagedReportMeta
ConversionReportData
ConversionReportWithIncludes
ConversionState
ConversionStates
Conversions
Country
CreateDraft
CreatePipelineRequest
Currency
CustomField
CustomFieldValue
CustomFilter
CustomFilterColumn
CustomFilterCondition
Deal
DealPagedReportMeta
DealProjectsData
DealReportData
DealReportMetaStatus
DealReportMetaStatuses
DealReportStatus
DealReportStatuses
DealReportWithIncludes
DeleteDraft
EmailAccount
EmailConnection
EmailFile
EmailMailbox
EmailMessage
EmailPagedReportMeta
EmailParticipant
EmailProvider
EmailProviderSettings
EmailReportData
EmailReportWithIncludes
EmailThread
EntityPosition
Event
Export
FeatureAnnouncement
File
FileThumbnail
FileUploadRequest
FileUploadRequestFile
Follower
ForecastUnit
ForeignItemLink
ForeignItemLinkCounts
ImportHistory
ImportsListResponse
Included
InstallationSettings
ListResponseMeta
LostReason
Note
NullInt
OvertimePoint
OvertimeReportData
OvertimeReportDataMeta
OvertimeReportWithIncludes
Page
PatchPipelineRequest
PhoneCode
Pipeline
PipelineResponse
PipelinesResponse
Product
ReportPage
ResourceIdentifier
ResourceIdentifierRequest
ResponseMeta
SearchableEntity
Stage
Timezone
UpdateDraft
User
VelocityPagedReportMeta
VelocityReportAge
VelocityReportAges
VelocityReportData
VelocityReportWithIncludes
VelocityStageReportAge
Webhook
WebhookEvent
WebhookRequest
WonReason
activitiesListResponse
activitiesResponse
activityPositionResponse
activityResponse
activityTypeResponse
activityTypesResponse
bulkUpdateActivityRequestWithOptions
bulkUpdateCompanyFollowers
bulkUpdateCompanyFollowersRequest
bulkUpdateCompanyRequestWithOptions
bulkUpdateContactFollowers
bulkUpdateContactFollowersRequest
bulkUpdateContactRequestWithOptions
bulkUpdateDealFollowers
bulkUpdateDealFollowersRequest
bulkUpdateDealRequestWithOptions
bulkUpdatePipelineFollowers
bulkUpdatePipelineFollowersRequest
bulkUpdateProductRequestWithOptions
bulkUpdateResponse
bulkUpdateRetryRequest
bulkUpdateUserRequestWithOptions
companiesListResponse
companiesResponse
companyFollowerRequest
companyFollowerResponse
companyFollowersResponse
companyPositionResponse
companyResponse
completeInviteRequest
connectEmailRequest
connectMessageResponse
contactFollowerRequest
contactFollowerResponse
contactFollowersResponse
contactPositionResponse
contactResponse
contactsListResponse
contactsResponse
countriesResponse
countryResponse
createActivityRequest
createActivityTypeRequest
createAndConnectMessageRequest
createCompanyRequest
createContactRequest
createCustomFieldRequest
createCustomFilterRequest
createDealMeta
createDealRequest
createDraftRequest
createExportRequest
createLostReason
createLostReasonRequest
createMessageRequest
createNote
createNoteRequest
createProductRequest
createStageRequest
createWebhookRequest
createWonReason
createWonReasonRequest
createdFilesResponse
currenciesResponse
currencyResponse
customFieldResponse
customFieldsResponse
customFilterColumnRequest
customFilterConditionRequest
customFilterResponse
customFiltersResponse
dealFollowerRequest
dealFollowerResponse
dealFollowersResponse
dealListMeta
dealPositionResponse
dealResponse
dealResponseMeta
dealsListResponse
dealsResponse
deleteDraftRequest
deleteEmailThreadsRequest
disconnectDealForeignLinksRequest
docErrorResp
duplicateContactRequest
emailAccountResponse
emailAccountsResponse
emailConnectionRequest
emailConnectionResponse
emailConnectionsResponse
emailContactMetaResponse
emailContactResponse
emailCreateManyConnectionsRequest
emailCreateManyConnectionsResponse
emailMessageResponse
emailProvidersResponse
emailThreadResponse
eventsResponse
exportResponse
exportsResponse
featureAnnouncementsResponse
feedbackRequest
fileResponse
filesResponse
forecastResponse
idsRequest
installationSettingsResponse
inviteRequest
lostReasonResponse
lostReasonsResponse
mailboxResponse
mailboxesResponse
meResponse
messagesResponse
noteResponse
patchActivityRequest
patchActivityTypeRequest
patchCompanyRequest
patchContactRequest
patchCustomFieldRequest
patchCustomFilterRequest
patchDealRequest
patchDraftRequest
patchEmailAccount
patchEmailAccountRequest
patchEmailMessageRequest
patchEmailThreadRequest
patchEmailThreadsRequest
patchFileRequest
patchInstallationSettingsRequest
patchLostReason
patchLostReasonRequest
patchMailboxRequest
patchNote
patchNoteRequest
patchProductRequest
patchStageRequest
patchUserRequest
patchWebhookRequest
patchWonReason
patchWonReasonRequest
phoneCodesResponse
pipelineBoardMetaResponse
pipelineBoardResponse
pipelineFollowerRequest
pipelineFollowerResponse
pipelineFollowersResponse
productResponse
productsListResponse
productsResponse
searchableResponse
sessionResponse
stageGetMeta
stageResponse
stagesResponse
subscriptionURLSResponse
threadResponse
threadsResponse
timezoneResponse
timezonesResponse
unreadCountResponse
uploadEmailFileRequest
uploadEmailFileResponse
userPositionResponse
userResponse
userState
userStateResponse
usersListResponse
usersResponse
webhookEventsMeta
webhookEventsResponse
webhookRequestResponse
webhookRequestsResponse
webhookResponse
webhooksResponse
wonReasonResponse
wonReasonsResponse
Powered by Stoplight

stageResponse

object
included
object

Included contains all the side-loaded data of a response. See including related entities.

meta
object
stage
object

Stage represents a stage in the CRM system.