v1

latestOpenAPI 3.0.32026-08-068925782.3 MB
Assets

Subscription endpoints allows the listing of Subscription objects and rendering the Control Panel template.

get/assets

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

configurationstring

This filter is used for explicit negative select. For example, select(-configuration). It will not return "configuration" object in the response. Please consider using this negative select if in your application you do not need to treat "configuration" object, it may dramatically increase /assets API performance.

lookups:

connection.hub.idstring

Filter for: connection.hub.id

lookups: eq, ne, like, ilike, null, in, out

null: HB-0000-0000, null()

connection.hub.namestring

Filter for: connection.hub.name

lookups: eq, ne, like, ilike, in, out

connection.idstring

Filter for: connection.id

lookups: eq, ne, like, ilike, null, in, out

null: CT-0000-0000-0000, null()

connection.provider.idstring

Filter for: connection.provider.id

lookups: eq, ne, like, ilike, null, in, out

search: true

connection.provider.namestring

Filter for: connection.provider.name

lookups: eq, ne, like, ilike, in, out

search: true

connection.type'test' | 'production'

Filter for: connection.type

lookups: eq, ne, like, ilike, in, out

connection.vendor.idstring

Filter for: connection.vendor.id

lookups: eq, ne, like, ilike, null, in, out

search: true

connection.vendor.namestring

Filter for: connection.vendor.name

lookups: eq, ne, like, ilike, in, out

search: true

contract.idstring

Filter for: contract.id

lookups: eq, ne, like, ilike, null, in, out

null: CRD-00000-00000-00000, null()

createdstring date-time

Filter for: created

lookups: gt, lt

ordering: true

external_idstring

Filter for: external_id

lookups: eq, ne, like, ilike, null, in, out

search: true

external_uidstring

Filter for: external_uid

lookups: eq, ne, like, ilike, null, in, out

hub.idstring

Filter for: hub.id

lookups: eq, ne, like, ilike, null, in, out

null: HB-0000-0000, null()

hub.namestring

Filter for: hub.name

lookups: eq, ne, like, ilike, in, out

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

search: true

itemsstring

This filter is used for explicit negative select. For example, select(-items). It will not return "items" list in the response. Please consider using this negative select if in your application you do not need to treat "items" list, it may dramatically increase /assets API performance.

lookups:

marketplace.idstring

Filter for: marketplace.id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

null: MP-00000, null()

marketplace.namestring

Filter for: marketplace.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

params.idstring

Filter for: params.id

lookups: eq, ne, like, ilike, in, out

params.valuestring

Filter for: params.value

lookups: eq, ne, like, ilike, null, in, out

pending_requeststring

This filter is used for explicit select. For example, select(pending_request) will include the "pending_request" object in the response. For performance reasons, use select(pending_request) only if you need this object.

lookups:

default: hidden

pending_request.templatestring

This filter is used for explicit select. For example, select(pending_request.template) will include the "pending_request" object in the response, which in turn will include the "template" object. For performance reasons, use select(pending_request.template) only if you need this object.

lookups:

default: hidden

product.idstring

Filter for: product.id

lookups: eq, ne, like, ilike, null, in, out

search: true

product.namestring

Filter for: product.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

product.titlestring

Filter for: product.title

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

status'draft' | 'processing' | 'active' | 'terminating' | 'suspended' | 'terminated'

Filter for: status

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

templatestring

This filter is used for explicit select. For example, select(template). If you need to treat template.id or template.name data in your application for assets, please consider adding this select(template) into your request.

lookups:

default: hidden

template.idstring

Filter for: template.id

lookups: eq, ne, like, ilike, null, in, out

tiers.customer.external_idstring

Filter for: tiers.customer.external_id

lookups: eq, ne, like, ilike, null, in, out

search: true

tiers.customer.external_uidstring

Filter for: tiers.customer.external_uid

lookups: eq, ne, like, ilike, in, out

search: true

tiers.customer.idstring

Filter for: tiers.customer.id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

tiers.customer.namestring

Filter for: tiers.customer.name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

tiers.tier1.idstring

Filter for: tiers.tier1.id

lookups: eq, ne, like, ilike, null, in, out

tiers.tier2.idstring

Filter for: tiers.tier2.id

lookups: eq, ne, like, ilike, null, in, out

updatedstring date-time

Filter for: updated

lookups: gt, lt

ordering: true

Response

idstring
status'draft' | 'processing' | 'active' | 'terminating' | 'suspended' | 'terminated'
external_idstring nullable required
external_uidstring nullable required
renewal_expiration_datestring date-time nullable