Zum Hauptinhalt springen
GET
/
offers
List offers
curl --request GET \
  --url https://coreapi.io/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": "1M",
            "cancellationPeriod": "1M"
          }
        ],
        "status": "active",
        "activatedAt": "2021-01-01T00:00:00+00:00",
        "poNumber": "PO-00000001",
        "contractDetails": {
          "contractStart": "2021-01-01T00:00:00+00:00",
          "contractEnd": "2021-01-01T00:00:00+00:00"
        },
        "trialEndsOn": "2021-01-01T00:00:00+00:00",
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "statistics": {
          "unpaidGrossAmount": {
            "amount": 1000,
            "precision": 2,
            "currency": "EUR",
            "i18n": "10,00 €",
            "inputValue": "10.00"
          },
          "totalContractValue": {
            "amount": 1000,
            "precision": 2,
            "currency": "EUR",
            "i18n": "10,00 €",
            "inputValue": "10.00"
          }
        },
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00",
        "nextBillingDate": "2021-01-01T00:00:00+00:00",
        "lastBillingAt": "2021-01-01T00:00:00+00:00",
        "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>",
      "sections": [
        "<string>"
      ],
      "customVariables": {},
      "locale": "<string>",
      "recipients": [
        {
          "id": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "createdAt": "2021-01-01T00:00:00+00:00",
          "signingStatus": "not_started",
          "signingLog": [
            "<string>"
          ],
          "signedDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
          "link": "https://example.com/o/1/recipient-1"
        }
      ],
      "purchaseOrderDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
      "auditLogDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
      "signedDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
      "signedAt": "2021-01-01T00:00:00+00:00",
      "autoActivateSubscription": true,
      "acceptanceMode": "click",
      "dealType": "new_business",
      "validUntil": "2021-01-01T00:00:00+00:00",
      "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>",
        "phone": "<string>",
        "linkedin": "<string>",
        "position": "<string>",
        "website": "<string>"
      },
      "signed": true,
      "issuedAt": "2021-01-01T00:00:00+00:00",
      "publishedVersionHash": "<string>",
      "currentVersionHash": "<string>"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Autorisierungen

​
Authorization
string
header
erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Abfrageparameter

​
page
integer
Standard:1

The collection page number

​
limit
integer
Standard:30

The number of items per page

Erforderlicher Bereich: 0 <= x <= 100
​
status
string
​
status[]
string[]
​
contactPerson
string
​
contactPerson[]
string[]
​
dealType
string
​
dealType[]
string[]
​
acceptanceMode
string
​
acceptanceMode[]
string[]
​
exists[subscription]
boolean
​
order[number]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[name]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[status]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[dealType]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[acceptanceMode]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[signedAt]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[validUntil]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[createdAt]
enum<string>
Verfügbare Optionen:
asc,
desc
​
order[updatedAt]
enum<string>
Verfügbare Optionen:
asc,
desc
​
signed
string

Antwort

200 - application/json

Offer collection

​
data
object[]
​
meta
object