Skip to main content
GuidesAPI Reference

Get Opportunity

GET 
/crm/opportunities/:opportunityId

Get opportunity based on id

Request​

Path Parameters

    opportunityId stringrequired

    The item id of the opportunity record

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    opportunity

    object

    id string
    remoteId string
    opportunityName string
    opportunityDescription string
    amount integer

    Default value: 0

    opportunityOwner string
    opportunityAccount string
    opportunityStage string
    opportunityStatus string
    lastActivityAt string
    closeDate string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...