Get an asset event definition

Request#

GET /api/v1/asset-events/{event}

Requires asset-events:read and an active token creator who remains an administrator of the token’s organization. Event setup and permissions.

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

Path parameters#

event integer Required

Definition ID from list definitions. Use the returned replacement ID after customizing a shared default.

Query parameters#

This endpoint does not use query parameters.

Example#

Replace the example ID with an ID from your organization. Set ASSETCENTER_API_TOKEN as described in the quick start.

curl --request GET "https://my.assetcenter.app/api/v1/asset-events/42" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json"

Response#

200 OK. Illustrative values; IDs and positions will differ.

{
  "data": {
    "id": 42,
    "group": "lifecycle",
    "name": "Inspection",
    "icon": "box",
    "color": "gray",
    "visible": true,
    "is_system": false,
    "is_global": false,
    "parent_id": null,
    "position": 3,
    "limit_to_categories": [],
    "cost_category_id": null,
    "can_delete": true,
    "fields": []
  }
}

Behavior and constraints#

fields contains the ordered definitions, with id, nullable slug, name, datatype, size, integer position, boolean is_system, is_required, visible, and has_values. can_delete reflects current references and system protections. is_global identifies a shared default; parent_id identifies the original shared definition for an organization override. Shared-field has_values only reflects this organization, including draft history. GET bodies are rejected.

Errors#

401 means the customer token is missing, invalid, expired, or revoked, or its creator is inactive. 403 means the required permission or administrator membership is missing. 404 means the definition is unavailable in the token’s organization, including a shared ID already overridden. 422 means invalid or unsupported input. 429 means the rate limit was reached. Errors and limits.