Person event options

Request#

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

Requires people: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 person 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.

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/people/123/events/options" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json"

Response#

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

{
  "data": [
    {
      "id": 42,
      "name": "Badge issued",
      "sets_status": null,
      "fields": [
        {
          "id": 101,
          "slug": "date",
          "name": "Date",
          "datatype": "date",
          "required": false
        },
        {
          "id": 104,
          "slug": null,
          "name": "Badge number",
          "datatype": "text",
          "required": true
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 1
  },
  "links": {
    "next": null,
    "prev": null
  }
}

Behavior and constraints#

Returns the visible person event definitions in display order, each with its visible fields. Use a field’s id as the key in field_values when logging the event. Built-in fields with a slug of date, time, or notes are not sent through field_values: date and time correspond to event_date, and notes to description. When they are required, those inputs become required. sets_status shows whether logging the type also changes the person’s status, which needs people:lifecycle as well. Follow links.next to read all pages.

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 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.