AFaffinity
Opportunities

Get all Opportunities

Changed on

Paginate through Opportunities in Affinity. Returns basic information but not field data on each 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.

Requires the "Export data from Lists" permission.

get/v2/opportunities

Request

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

Query parameters

cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw

Cursor for the next or previous page

limitinteger
Example:100

Number of items to include in the page

idsinteger[]

Opportunity IDs

Response

OK

Example response

{
  "data": [
    {
      "id": 1,
      "name": "Horizon Technologies Upsell $10k",
      "listId": 1,
      "listName": "Pipeline Q1 2024"
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

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