GET
/
offers
curl -X GET \
 /offers \
 --header "Authorization: Bearer <token>"
{
  "data": [
    {
      "id": "<string>",
      "subscription": {
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "externalId": "<string>",
        "number": "S-00000001",
        "name": "Fitness M",
        "billingGroup": {},
        "periods": [
          {
            "id": "<string>",
            "contractPeriodCount": 123,
            "contractPeriod": {},
            "cancellationPeriod": {}
          }
        ],
        "status": "<any>",
        "activatedAt": "2021-01-01T00:00:00+00:00",
        "poNumber": "PO-00000001",
        "contractDetails": {
          "contractStart": "2023-11-07T05:31:56Z",
          "contractEnd": "2023-11-07T05:31:56Z"
        },
        "trialEndsOn": "2021-01-01T00:00:00+00:00",
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00",
        "nextBillingDate": "2023-11-07T05:31:56Z",
        "lastBillingAt": "2023-11-07T05:31:56Z",
        "partner": {
          "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
          "name": "John Doe",
          "number": "123456",
          "email": "partner@example.com"
        }
      },
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "customerNumber": "CUSTOMER-000",
        "timeZone": "Europe/Berlin",
        "firstName": "John",
        "lastName": "Doe",
        "currencyCode": "EUR",
        "companyName": "Acme Inc.",
        "datevId": "123456789",
        "status": "STATUS_ACTIVE"
      },
      "number": "<string>",
      "name": "<string>",
      "status": "open",
      "description": "<string>",
      "sections": [
        "<string>"
      ],
      "locale": "<string>",
      "recipients": [
        {
          "id": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "role": "read",
          "createdAt": "2023-11-07T05:31:56Z",
          "signingStatus": "not_started",
          "signingLog": [
            "<string>"
          ],
          "signedDocument": "https://example.com/",
          "link": "https://example.com/offers/1/recipient-1"
        }
      ],
      "auditLogDocument": "https://example.com/",
      "signedDocument": "https://example.com/",
      "signedAt": "2023-11-07T05:31:56Z",
      "autoActivateSubscription": true,
      "crmDealId": "<string>",
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00",
      "contactPerson": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "avatar": "<string>"
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Query Parameters

​
page
integer
default:
1

The collection page number

​
limit
integer
default:
30

The number of items per page

Required range: 0 < x < 100

Response

200
application/json
Offer collection
​
data
object[]
​
meta
object

Was this page helpful?

Get a collection of billing groupsGet an offer