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

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

Disconects foreign item links to a 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

Models

CreatePipelineRequest

CustomFieldValue

CustomFilterColumn

CustomFilterCondition

DealPagedReportMeta

DealProjectsData

DealReportStatus

DealReportStatuses

DealReportWithIncludes

EmailParticipant

EmailProviderSettings

FeatureAnnouncement

FileUploadRequest

FileUploadRequestFile

ForeignItemLink

ForeignItemLinkCounts

ImportsListResponse

InstallationSettings

ListResponseMeta

OvertimeReportData

OvertimeReportDataMeta

OvertimeReportWithIncludes

PatchPipelineRequest

PipelineResponse

PipelinesResponse

ResourceIdentifier

ResourceIdentifierRequest

SearchableEntity

activitiesListResponse

activitiesResponse

activityPositionResponse

activityResponse

activityTypeResponse

activityTypesResponse

bulkUpdateActivityRequestWithOptions

bulkUpdateCompanyRequestWithOptions

bulkUpdateContactRequestWithOptions

bulkUpdateDealRequestWithOptions

bulkUpdateProductRequestWithOptions

bulkUpdateResponse

bulkUpdateRetryRequest

bulkUpdateUserRequestWithOptions

companiesListResponse

companiesResponse

companyPositionResponse

companyResponse

completeInviteRequest

connectEmailRequest

contactPositionResponse

contactResponse

contactsListResponse

contactsResponse

countriesResponse

countryResponse

createActivityRequest

createActivityTypeRequest

createCompanyRequest

createContactRequest

createCustomFieldRequest

createCustomFilterRequest

createDealRequest

createDraftRequest

createExportRequest

createLostReason

createLostReasonRequest

createNoteRequest

createProductRequest

createStageRequest

createWebhookRequest

createWonReason

createWonReasonRequest

createdFilesResponse

currenciesResponse

currencyResponse

customFieldResponse

customFieldsResponse

customFilterColumnRequest

customFilterConditionRequest

customFilterResponse

customFiltersResponse

dealPositionResponse

dealsListResponse

deleteEmailThreadsRequest

disconnectDealForeignLinksRequest

duplicateContactRequest

emailAccountResponse

emailAccountsResponse

emailMessageResponse

emailProvidersResponse

emailThreadResponse

exportsResponse

featureAnnouncementsResponse

feedbackRequest

forecastResponse

installationSettingsResponse

lostReasonResponse

lostReasonsResponse

mailboxResponse

mailboxesResponse

messagesResponse

patchActivityRequest

patchActivityTypeRequest

patchCompanyRequest

patchContactRequest

patchCustomFieldRequest

patchCustomFilterRequest

patchDealRequest

patchEmailAccount

patchEmailAccountRequest

patchEmailMessageRequest

patchEmailThreadRequest

patchEmailThreadsRequest

patchFileRequest

patchInstallationSettingsRequest

patchLostReason

patchLostReasonRequest

patchMailboxRequest

patchNoteRequest

patchProductRequest

patchStageRequest

patchUserRequest

patchWebhookRequest

patchWonReasonRequest

phoneCodesResponse

pipelineBoardMetaResponse

pipelineBoardResponse

productResponse

productsListResponse

productsResponse

searchableResponse

sessionResponse

subscriptionURLSResponse

threadsResponse

timezoneResponse

timezonesResponse

unreadCountResponse

uploadEmailFileRequest

uploadEmailFileResponse

userPositionResponse

userStateResponse

usersListResponse

webhookEventsMeta

webhookEventsResponse

webhookRequestResponse

webhookRequestsResponse

webhookResponse

webhooksResponse

wonReasonResponse

wonReasonsResponse

Powered by Stoplight

get

/pipelines.json

Returns a list of pipelines sorted by orderIndex.

The following values are allowed in the include query parameter:

stages

The following targets are allowed in filter query parameters:

createdAt
isQualified
name
updatedAt

The following values are allowed in the sort query parameter:

createdAt
orderIndex (default)
updatedAt

Request Parameters

5 Query Parameters

Responses

200 OK

Schema

object

PipelinesResponse contains the body for a list of pipelines.

included

object

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

meta

object

ResponseMeta contains common meta data.

pipelines

array[object]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

1 variable not set

host