List person event definitions

Request#

GET /api/v1/person-events

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

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

Query parameters#

page integer Optional

Page number, starting at 1. Defaults to 1.

per_page integer Optional

Results per page, 1–100. Defaults to 25.

group string Optional

Accepts only person. Omit it; every definition here is in that group.

visible boolean Optional

Use 1 for enabled definitions or 0 for hidden definitions. Omit to include both.

Example#

Set ASSETCENTER_API_TOKEN as described in the quick start.

curl --request GET "https://my.assetcenter.app/api/v1/person-events?visible=1&per_page=25" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json"

Response#

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

{
  "data": [
    {
      "id": 42,
      "group": "person",
      "name": "Badge issued",
      "icon": "user",
      "color": "gray",
      "visible": true,
      "is_system": false,
      "is_global": false,
      "parent_id": null,
      "position": 0,
      "limit_to_categories": [],
      "cost_category_id": null,
      "sets_status": null
    }
  ],
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 1
  }
}

Behavior and constraints#

Definitions are ordered by position, then numeric ID. Follow links.next until null; additional pagination links and metadata are present. Lists omit fields and can_delete; use the detail endpoint for those. GET request bodies and unsupported filters 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. 422 means invalid or unsupported input. 429 means the rate limit was reached. Errors and limits.