Asset subscriptions assignment options

Request#

GET /api/v1/assets/{record}/assignments/subscriptions/options

Requires assets:assignments, subscriptions:update. See token permissions. Every listed permission is required for this endpoint.

Send Authorization: Bearer YOUR_API_TOKEN and Accept: application/json.

record is the numeric asset ID in your token’s organization.

Query parameters#

page integer Optional

The page of results to return. Starts at 1; defaults to 1.

per_page integer Optional

The maximum number of results per page. Accepts 1–100; defaults to 25.

kind string Optional

The type of choices to return: subscriptions for subscriptions. Defaults to subscriptions.

Example#

Set ASSETCENTER_API_TOKEN as described in the quick start. Replace example record and option IDs with values from your organization.

curl --request GET "https://my.assetcenter.app/api/v1/assets/123/assignments/subscriptions/options" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json"

Response#

200 OK. Example response; IDs, values, and timestamps will differ in your organization.

{
  "data": [
    {
      "id": 42,
      "name": "Editor",
      "plan_type": "Enterprise",
      "vendor_name": "Example Software",
      "display_name": "Example Software Editor Enterprise",
      "status": "available"
    }
  ],
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 1
  }
}

Behavior and constraints#

Returns eligible choices from your organization. Follow links.next to read all pages. Several subscriptions can share a name across vendors or plans, so show display_name (vendor name, name and plan type, leaving out any that are empty) when a person picks from the list. plan_type and vendor_name may be null.

Errors#

401 means the token is missing, expired, revoked, or not a customer API token. 403 means a required permission or administrator access is missing. 404 means the record or child record is unavailable in this organization. 422 identifies invalid or unsupported input; inspect the errors object when present. 429 means a rate limit was reached. See error handling and rate limits.