The identity and technical contract details declared by the specification.
BaseListResponse_DealNote_
object
The list responses.
1 property
BaseListResponse_Deal_
object
The list responses.
1 property
BaseListResponse_PipelineCustomField_
object
The list responses.
1 property
BaseListResponse_PipelineDealWithStageName_
object
The list responses.
1 property
BaseListResponse_PipelineSummary_
object
The list responses.
1 property
BaseListResponse_Pipeline_
object
The list responses.
1 property
BaseListResponse_Stage_
object
The list responses.
1 property
BulkCreateDealNoteRequest
object
Request model for creating a deal note as part of a bulk operation.
3 properties
3 required
BulkCreateDealNoteResponse
object
Response model for creating a deal note as part of a bulk operation.
8 properties
BulkCreateDealNotesRequest
object
Request model for creating multiple deal notes in bulk.
1 property
1 required
BulkCreateDealNotesResponse
object
Response model for creating multiple deal notes in bulk.
1 property
CreateDealInBulkRequest
object
Request model for creating one deal as part of a bulk creation.
11 properties
8 required
CreateDealInBulkResponse
object
Response model for creating multiple deals in bulk.
3 properties
CreateDealNoteRequest
object
Request model for creating a deal note.
2 properties
2 required
CreateDealRequest
object
Request model for creating a deal.
10 properties
7 required
CreateDealsInBulkRequest
object
Request model for creating multiple deals in bulk.
1 property
1 required
CreateDealsInBulkResponse
object
Response model for creating multiple deals in bulk.
1 property
CreatePipelineCustomFieldRequest
object
Class representing a request to create a custom field.
10 properties
1 required
CreatePipelineRequest
object
Request for creating a pipeline.
2 properties
2 required
CreateStageRequest
object
Request for creating a stage.
2 properties
2 required
DateExpression
object
9 properties
8 required
DateExpressionResponse
object
1 property
Deal
object
Represents a deal.
13 properties
DealContact
object
Represents a contact entity in the system.
2 properties
1 required
DealCustomFieldsPropertyValidationResult
object
Response model for validating a single custom field in a deal.
5 properties
DealCustomFieldsValidationRequest
object
Request model for validating custom fields in deals.
1 property
1 required
DealCustomFieldsValidationResponse
object
Response model for validating custom fields in deals.
2 properties
2 required
DealListResponse
object
Response model for a list of deals.
DealNote
object
A model representing a note associated with a deal.
6 properties
DealNoteListResponse
object
Response model for a list of deal notes.
DealStatus
string
Enum representing the status of a deal.
DisplayForm
object
A display form for a sales pipeline
1 property
DisplayGroup
object
A group of properties on a display form
5 properties
DisplayProperty
object
A property for a group inside a display form
10 properties
DisplayPropertySource
string
Enum representing the source of a display property.
FilterEntry
object
Represents an entry in a filter.
3 properties
3 required
FilterOperator
string
Enum representing filter operators.
LogicalDate
object
2 properties
Money
object
Represents a monetary value with an amount and currency.
2 properties
2 required
MoveDealsForContactsRequest
object
Request model for moving specific deals.
3 properties
3 required
MoveDealsForContactsResponse
object
Response model for moving deals of contacts in bulk.
1 property
Owner
object
Represents an owner entity in the system.
1 property
Pipeline
object
A pipeline
2 properties
PipelineCustomField
object
Represents a custom field in the system. This class extends the BaseModel and includes various properties related to custom fields.
10 properties
2 required
PipelineCustomFieldArrayDisplayOptions
object
Class representing display options for an array custom field.
2 properties
2 required
PipelineCustomFieldArrayPropertyType
object
Class representing the type of an array property in a custom field.
1 property
1 required
PipelineCustomFieldBooleanDisplayOptions
object
Class representing display options for a boolean custom field.
1 property
1 required
PipelineCustomFieldBooleanDisplayType
string
Enum representing the display types for a boolean custom field.
PipelineCustomFieldCardDisplayOptions
object
Class representing display options for a card custom field.
1 property
PipelineCustomFieldCardProperty
object
Class representing a property of a card custom field.
2 properties
PipelineCustomFieldDateTimeOptions
object
Class representing options for date and time custom fields.
2 properties
PipelineCustomFieldDisplayOptions
object
Class representing display options for a custom field.
7 properties
2 required
PipelineCustomFieldDisplayOptionsType
string
Enum representing the types of display options for custom fields.
PipelineCustomFieldDisplayStyle
string
Enum representing the display styles for custom fields.
PipelineCustomFieldDurationDisplayOptions
object
Class representing display options for a custom field with duration type.
1 property
PipelineCustomFieldDurationOptionsDurationUnit
string
Enum representing the duration units for custom fields.
PipelineCustomFieldEmptyStateContent
object
Class representing the content for an empty state in custom fields.
2 properties
2 required
PipelineCustomFieldModelPropertyTypeDiscriminator
string
Enum representing the types of model property type discriminators.
PipelineCustomFieldOption
object
Class representing an option for a custom field.
4 properties
4 required
PipelineCustomFieldOptionDisplayType
string
Enum representing the display types for custom field options.
PipelineCustomFieldOptionGroup
object
Class representing a group of custom field options.
3 properties
2 required
PipelineCustomFieldOptions
object
Class representing the options for a custom field.
4 properties
2 required
PipelineCustomFieldPrimitiveType
string
Enum representing various primitive types for custom fields.
PipelineCustomFieldPropertyValidator
object
Class representing a validator for custom field properties.
2 properties
2 required
PipelineCustomFieldRefDisplayOptions
object
Class representing the display options for a reference custom field.
7 properties
PipelineCustomFieldRefDisplayType
string
Enum representing the display types for a reference custom field.
PipelineCustomFieldRefPropertyType
object
Class representing the property type for a reference custom field.
2 properties
1 required
PipelineCustomFieldRefType
object
Class representing a reference type for custom fields.
2 properties
PipelineCustomFieldSizeValidationType
string
Enum representing the types of size validation for custom fields.
PipelineCustomFieldSizeValidator
object
Class representing a size validator for custom fields.
2 properties
2 required
PipelineCustomFieldType
object
Class representing a custom field type.
4 properties
2 required
PipelineCustomFields
object
Represents a list of custom fields in the system.
1 required
PipelineDealWithStageName
object
A deal, including its stage name.
13 properties
1 required
PipelineDealsListResponse
object
Request for a list of a given deal's pipelines.
PipelineListResponse
object
Response for a list of pipelines.
PipelineOutcomeLabel
object
Represents a label for a pipeline outcome.
2 properties
1 required
PipelineOutcomeLabelListResponse
object
Represents a response containing a list of pipeline outcome labels.
2 properties
PipelineStageListResponse
object
Response for a list of stages.
PipelineSummariesListResponse
object
Response for a list of pipeline summaries.
PipelineSummary
object
Represents a summary of a pipeline.
4 properties
1 required
Stage
object
Represents a stage in a pipeline.
3 properties
StageDealListResponse
object
Response for a list of deals in a stage.
StageListResponse
object
Response for a list of stages.
UpdateCustomFieldRequest
object
Represents a request to update a custom field.
9 properties
UpdateDealNoteRequest
object
Request model for updating a deal note.
1 property
1 required
UpdateDealRequest
object
Request model for updating a deal.
14 properties
2 required
UpdateDealsInBulkRequest
object
Request for updating the deals of a pipeline.
5 properties
4 required
UpdateDealsInBulkResponse
object
Response for a bulk update for the reals in a pipeline.
2 properties
1 required
UpdateDisplayFormRequest
object
1 property
1 required
UpdateDisplayGroupRequest
object
4 properties
2 required
UpdateDisplayPropertyRequest
object
10 properties
1 required
UpdateOutcomeLabelsRequest
object
Represents a request to update outcome labels for a pipeline.
1 property
1 required
UpdatePipelineRequest
object
Request for updating a pipeline.
1 property
1 required
UpdateStageRequest
object
Request for updating a stage.
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Infusionsoft (Keap) publishes across the network.
