List Opportunities

GET 
/crm/opportunities

List opportunities based on a given criteria

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

opportunityName string

Filter opportunities by their exact name.

opportunityNameContains string

Filter opportunities where the name contains the specified string.

opportunityNameNotEquals string

Filter opportunities where the name is not the specified string.

opportunityStage string

Filter opportunities by their exact current stage (e.g., Lead, Qualified, Proposal).

opportunityStageContains string

Filter opportunities where the current stage contains the specified string.

opportunityStageNotEquals string

Filter opportunities where the current stage is not the specified string.

amountStage string

Filter opportunities based on the exact stage or status of the amount (e.g., Estimated, Finalized).

amountStageContains string

Filter opportunities where the amount stage contains the specified string.

amountStageNotEquals string

Filter opportunities where the amount stage is not the specified string.

opportunityDescription string

Filter opportunities by their exact description.

opportunityDescriptionContains string

Filter opportunities where the description contains the specified string.

opportunityDescriptionNotEquals string

Filter opportunities where the description is not the specified string.

lastActivityAt string

Filter opportunities by the exact date/time of their last activity.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

opportunities

object[]

Array [

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

]

Example (from schema)

{
  "opportunities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "remoteId": "1000000000001",
      "opportunityName": "Innovative Tech Solutions",
      "opportunityDescription": "Developing new software tools for market research",
      "amount": 120000,
      "opportunityOwner": "1000000000002",
      "opportunityAccount": "1000000000003",
      "opportunityStage": "Proposal/Price Quote",
      "opportunityStatus": "Active",
      "lastActivityAt": "2023-09-20",
      "closeDate": "2023-12-15",
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z"
    }
  ]
}

Result

{
  "opportunities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "remoteId": "1000000000001",
      "opportunityName": "Innovative Tech Solutions",
      "opportunityDescription": "Developing new software tools for market research",
      "amount": 120000,
      "opportunityOwner": "1000000000002",
      "opportunityAccount": "1000000000003",
      "opportunityStage": "Proposal/Price Quote",
      "opportunityStatus": "Active",
      "lastActivityAt": "2023-09-20",
      "closeDate": "2023-12-15",
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z"
    }
  ]
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...