Get Subscription Overview
Get an overview of all subscriptions that authorized the application
Query Parameters
- subscriptionId uuid
Subscription id
- offset int32
Offset for paging
- limit int32
Default value:
25
Limit for paging
Header Parameters
- etag string
Etag
- 200
- 304
- 400
- 401
Successful
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
- totalCount int32 required
Total count of items
subscriptions object[] nullable
List of subscription information
Array [subscriptionId uuid requiredSubscription id
parentSubscriptionId uuid nullableParent subscription id
name string nullableSubscription name
tapioId string nullableTapio id
assignedMachines object[] nullable
Assigned machines
Array [tmid string nullableTapioMachineId
deviceType objectDevice type
deviceSubType string nullableDevice sub-type. If Device type is set to "Machine", Device sub-type will only contain one the following values: "Unknown", "Edge", "Saw", "Cnc", "Sanding", "Drilling", "Assembly", "Storing", "Stock", "Sorting", "Shipping", "PreAssembly", "Lamination", "Moulding", "Packaging", "Handling"
displayName string nullableDisplay name
manufacturerSerialNumber string nullableSerial number given to the machine by its manufacturer.
onboardingDate date-time requiredThe date, when the machine has been added to the subscription
equipmentGroup object nullable
Information about a group in the context of a machine, assigned to it.
id string nullableId of the equipment group.
groupPosition int32 requiredPosition of the machine within the group.
assignedApplications object[] nullable
List of assigned applications for this machine
Array [id uuid requiredApplication id
]]subscriptionTypes string[] nullable deprecatedSubscription Types
subscriptionType string nullableSubscription Type
subscriptionFeatures string[] nullableSubscription Features
servicePartners object[] nullable
Service partners
Array [subscriptionId uuid requiredSubscription id
name string nullableService partner name
customerNumber string nullableCustomer number
parentSubscriptionId uuid nullableParent id
providerNo string nullableProvider number
servicePartnerType objectService partner type
]licenses object[] nullable
Licenses
Array [licenseId uuid requiredLicense id
applicationId uuid requiredApplication id
createdDate date-time requiredLicense creation date
billingStartDate date-time requiredBilling start date
billingInterval string nullableBilling interval
licenseCount int32 requiredLicense count
]equipmentGroups object[] nullable
Equipment groups
Array [id string nullableEquipment group id
parentId string nullableId of the parent equipment group, or null if there is no parent.
displayName string nullableDisplay name
groupPosition int32 requiredPosition of the machine within the group
placesCount int32 requiredNumber of places in the equipment group
type object]servicePartnerType objectService partner type
]
{
"totalCount": 0,
"subscriptions": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parentSubscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"tapioId": "string",
"assignedMachines": [
{
"tmid": "string",
"deviceType": "Unknown",
"deviceSubType": "string",
"displayName": "string",
"manufacturerSerialNumber": "string",
"onboardingDate": "2025-07-11T14:07:00.697Z",
"equipmentGroup": {
"id": "string",
"groupPosition": 0
},
"assignedApplications": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
],
"subscriptionType": "string",
"subscriptionFeatures": [
"string"
],
"servicePartners": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"customerNumber": "string",
"parentSubscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"providerNo": "string",
"servicePartnerType": "MachineService"
}
],
"licenses": [
{
"licenseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2025-07-11T14:07:00.699Z",
"billingStartDate": "2025-07-11T14:07:00.699Z",
"billingInterval": "string",
"licenseCount": 0
}
],
"equipmentGroups": [
{
"id": "string",
"parentId": "string",
"displayName": "string",
"groupPosition": 0,
"placesCount": 0,
"type": "Group"
}
],
"servicePartnerType": "MachineService"
}
]
}
- Schema
- Example (from schema)
Schema
- totalCount int32 required
Total count of items
subscriptions object[] nullable
List of subscription information
Array [subscriptionId uuid requiredSubscription id
parentSubscriptionId uuid nullableParent subscription id
name string nullableSubscription name
tapioId string nullableTapio id
assignedMachines object[] nullable
Assigned machines
Array [tmid string nullableTapioMachineId
deviceType objectDevice type
deviceSubType string nullableDevice sub-type. If Device type is set to "Machine", Device sub-type will only contain one the following values: "Unknown", "Edge", "Saw", "Cnc", "Sanding", "Drilling", "Assembly", "Storing", "Stock", "Sorting", "Shipping", "PreAssembly", "Lamination", "Moulding", "Packaging", "Handling"
displayName string nullableDisplay name
manufacturerSerialNumber string nullableSerial number given to the machine by its manufacturer.
onboardingDate date-time requiredThe date, when the machine has been added to the subscription
equipmentGroup object nullable
Information about a group in the context of a machine, assigned to it.
id string nullableId of the equipment group.
groupPosition int32 requiredPosition of the machine within the group.
assignedApplications object[] nullable
List of assigned applications for this machine
Array [id uuid requiredApplication id
]]subscriptionTypes string[] nullable deprecatedSubscription Types
subscriptionType string nullableSubscription Type
subscriptionFeatures string[] nullableSubscription Features
servicePartners object[] nullable
Service partners
Array [subscriptionId uuid requiredSubscription id
name string nullableService partner name
customerNumber string nullableCustomer number
parentSubscriptionId uuid nullableParent id
providerNo string nullableProvider number
servicePartnerType objectService partner type
]licenses object[] nullable
Licenses
Array [licenseId uuid requiredLicense id
applicationId uuid requiredApplication id
createdDate date-time requiredLicense creation date
billingStartDate date-time requiredBilling start date
billingInterval string nullableBilling interval
licenseCount int32 requiredLicense count
]equipmentGroups object[] nullable
Equipment groups
Array [id string nullableEquipment group id
parentId string nullableId of the parent equipment group, or null if there is no parent.
displayName string nullableDisplay name
groupPosition int32 requiredPosition of the machine within the group
placesCount int32 requiredNumber of places in the equipment group
type object]servicePartnerType objectService partner type
]
{
"totalCount": 0,
"subscriptions": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parentSubscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"tapioId": "string",
"assignedMachines": [
{
"tmid": "string",
"deviceType": "Unknown",
"deviceSubType": "string",
"displayName": "string",
"manufacturerSerialNumber": "string",
"onboardingDate": "2025-07-11T14:07:00.701Z",
"equipmentGroup": {
"id": "string",
"groupPosition": 0
},
"assignedApplications": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
],
"subscriptionType": "string",
"subscriptionFeatures": [
"string"
],
"servicePartners": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"customerNumber": "string",
"parentSubscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"providerNo": "string",
"servicePartnerType": "MachineService"
}
],
"licenses": [
{
"licenseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2025-07-11T14:07:00.701Z",
"billingStartDate": "2025-07-11T14:07:00.701Z",
"billingInterval": "string",
"licenseCount": 0
}
],
"equipmentGroups": [
{
"id": "string",
"parentId": "string",
"displayName": "string",
"groupPosition": 0,
"placesCount": 0,
"type": "Group"
}
],
"servicePartnerType": "MachineService"
}
]
}
- Schema
- Example (from schema)
Schema
- totalCount int32 required
Total count of items
subscriptions object[] nullable
List of subscription information
Array [subscriptionId uuid requiredSubscription id
parentSubscriptionId uuid nullableParent subscription id
name string nullableSubscription name
tapioId string nullableTapio id
assignedMachines object[] nullable
Assigned machines
Array [tmid string nullableTapioMachineId
deviceType objectDevice type
deviceSubType string nullableDevice sub-type. If Device type is set to "Machine", Device sub-type will only contain one the following values: "Unknown", "Edge", "Saw", "Cnc", "Sanding", "Drilling", "Assembly", "Storing", "Stock", "Sorting", "Shipping", "PreAssembly", "Lamination", "Moulding", "Packaging", "Handling"
displayName string nullableDisplay name
manufacturerSerialNumber string nullableSerial number given to the machine by its manufacturer.
onboardingDate date-time requiredThe date, when the machine has been added to the subscription
equipmentGroup object nullable
Information about a group in the context of a machine, assigned to it.
id string nullableId of the equipment group.
groupPosition int32 requiredPosition of the machine within the group.
assignedApplications object[] nullable
List of assigned applications for this machine
Array [id uuid requiredApplication id
]]subscriptionTypes string[] nullable deprecatedSubscription Types
subscriptionType string nullableSubscription Type
subscriptionFeatures string[] nullableSubscription Features
servicePartners object[] nullable
Service partners
Array [subscriptionId uuid requiredSubscription id
name string nullableService partner name
customerNumber string nullableCustomer number
parentSubscriptionId uuid nullableParent id
providerNo string nullableProvider number
servicePartnerType objectService partner type
]licenses object[] nullable
Licenses
Array [licenseId uuid requiredLicense id
applicationId uuid requiredApplication id
createdDate date-time requiredLicense creation date
billingStartDate date-time requiredBilling start date
billingInterval string nullableBilling interval
licenseCount int32 requiredLicense count
]equipmentGroups object[] nullable
Equipment groups
Array [id string nullableEquipment group id
parentId string nullableId of the parent equipment group, or null if there is no parent.
displayName string nullableDisplay name
groupPosition int32 requiredPosition of the machine within the group
placesCount int32 requiredNumber of places in the equipment group
type object]servicePartnerType objectService partner type
]
{
"totalCount": 0,
"subscriptions": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parentSubscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"tapioId": "string",
"assignedMachines": [
{
"tmid": "string",
"deviceType": "Unknown",
"deviceSubType": "string",
"displayName": "string",
"manufacturerSerialNumber": "string",
"onboardingDate": "2025-07-11T14:07:00.702Z",
"equipmentGroup": {
"id": "string",
"groupPosition": 0
},
"assignedApplications": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
],
"subscriptionType": "string",
"subscriptionFeatures": [
"string"
],
"servicePartners": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"customerNumber": "string",
"parentSubscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"providerNo": "string",
"servicePartnerType": "MachineService"
}
],
"licenses": [
{
"licenseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2025-07-11T14:07:00.702Z",
"billingStartDate": "2025-07-11T14:07:00.702Z",
"billingInterval": "string",
"licenseCount": 0
}
],
"equipmentGroups": [
{
"id": "string",
"parentId": "string",
"displayName": "string",
"groupPosition": 0,
"placesCount": 0,
"type": "Group"
}
],
"servicePartnerType": "MachineService"
}
]
}
ETag matches
Bad request
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
Unauthorized
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}