Skip to navigation

Get a single OpportunityStatusChange activity

View as Markdown

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response
_typestring

Type of the activity, e.g. Call, Email or Note.

activity_atdatetime or null

When the activity happened, e.g. when an Email or SMS was sent. Defaults to date_created.

contact_idstring or null

ID of the Contact the activity is with, or null if it isn’t with a particular Contact.

created_bystring or null

ID of the user who created the activity, or null if it wasn’t created by a user.

date_createddatetime
When the activity was created.
date_updateddatetime
When the activity was last updated.
idstring

ID of the activity, e.g. acti_abc123.

lead_idstring or null

ID of the Lead the activity is on. Can be null for Calls and SMS with phone numbers that don’t match any Contact.

new_status_idstring
old_status_idstring
opportunity_idstring or null
organization_idstring
ID of the organization the activity belongs to.
updated_bystring or null

ID of the user who last updated the activity, or null if it wasn’t updated by a user.

user_idstring or null

ID of the user the activity belongs to, e.g. who made the Call or sent the Email. Can be null, e.g. for an incoming SMS to a group number.

userslist of strings
IDs of all users the activity is associated with, e.g. every Close user on an Email Thread or invited to a Meeting.
created_by_agent_idstring or nullOptional

ID of the agent that created the activity, or null if no agent created it.

created_by_namestring or nullOptional

Name of the user in created_by.

new_pipeline_idstringOptional
new_pipeline_namestringOptional
new_status_labelstringOptional
new_status_typeenumOptional

Type of an Opportunity Status: active for open Opportunities, won or lost for closed ones.

Allowed values:
old_pipeline_idstringOptional
old_pipeline_namestringOptional
old_status_labelstringOptional
old_status_typeenumOptional

Type of an Opportunity Status: active for open Opportunities, won or lost for closed ones.

Allowed values:
opportunity_confidenceinteger or nullOptional
opportunity_date_wondatetime or nullOptional
opportunity_valueinteger or nullOptional
opportunity_value_currencystring or nullOptional
opportunity_value_formattedstring or nullOptional
opportunity_value_periodenum or nullOptional

How often the Opportunity’s value is paid: one_time, monthly or annual.

Allowed values:
updated_by_agent_idstring or nullOptional

ID of the agent that last updated the activity, or null if the last update wasn’t made by an agent.

updated_by_namestring or nullOptional

Name of the user in updated_by.

user_namestring or nullOptional

Name of the user in user_id.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error