Skip to main content
GET
/
consumers
/
{consumer_id}
/
invoicing
/
opportunities
Retrieve all opportunities
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities
{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "name": "<string>",
      "total": 123,
      "probability": 123,
      "partner_id": "<string>",
      "comment": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "pipe_status": "<string>",
      "pipe_name": "<string>",
      "created_date": "2023-12-25",
      "due_date": "2023-12-25",
      "end_date": "2023-12-25",
      "is_won": true,
      "owner_ref": {
        "id": "<string>",
        "model": "<string>",
        "name": "<string>"
      }
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.chift.eu/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

​
items
OpportunityItem · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1