Asset event options

Request#

GET /api/v1/assets/{record}/events/options

Requires assets:events. 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: event_types for available event types and their fields, or people for active people. Defaults to event_types.

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/events/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": 12,
      "name": "Example event type",
      "slug": "example-event",
      "category": "lifecycle",
      "fields": []
    }
  ],
  "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. Event types are visible, match this action’s category, and apply to the asset category. Each field exposes id, name, slug, datatype, required, and options (choice id and label). Required built-in fields become required request properties; custom fields use field_values keyed by field ID. Select/dropdown fields take option IDs.

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.