AFaffinity
Opportunities

Get a single Opportunity

Changed on

Returns basic information but not field data on the requested Opportunity.

To access field data on Opportunities, use the /lists/{list_id}/list-entries or the /v2/lists/{list_id}/saved-views/{view_id}/list-entries GET endpoint.

get/v2/opportunities/{opportunityId}

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/opportunities/{opportunityId}
  • Auth
    HTTP bearer

Path parameters

opportunityIdinteger required

Opportunity ID

Response

OK

idinteger required

The unique identifier for the opportunity

namestring required

The name of the opportunity. When isRedacted is true, the real name is masked and this value is the literal string [Hidden].

listIdinteger required

The ID of the list that the opportunity belongs to

listNamestring required

The name of the list that the opportunity belongs to

isRestrictedboolean required

Whether the opportunity is restricted. false for customers without the Restricted Opportunities feature enabled.

isRedactedboolean required

Whether the response is redacted because the requesting user does not have access to this restricted opportunity. The real name is masked as [Hidden] when true. Always false when isRestricted is false.

Example response

{
  "id": 1,
  "name": "Horizon Technologies Upsell $10k",
  "listId": 1,
  "listName": "Pipeline Q1 2024"
}

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status