Stages

The Stage object is used to represent the stage of an opportunity.

The Stage object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
nameString
Optional
The stage's name.
remote_dataRemoteData[]
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
The Stage object
JSON
{
  "id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "remote_id": "19202938",
  "name": "Proposal",
  "remote_data": [
    {
      "path": "/stages",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}
GET

/stages

Returns a list of Stage objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
      "remote_id": "19202938",
      "name": "Proposal",
      "remote_data": [
        {
          "path": "/stages",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true
    }
  ]
}
Field support by platform

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/stages/{id}

Returns a Stage object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "remote_id": "19202938",
  "name": "Proposal",
  "remote_data": [
    {
      "path": "/stages",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}
Field support by platform

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
remote_idString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Opportunities

Next Up

Tasks