Person timeline lookup options

Request#

GET /api/v1/people/{record}/timeline/{type}/{entry}/options

Requires people:read, people:todos, and users:read. See token permissions. Timeline Update is not required to read choices.

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

Path parameters#

record integer Required

The numeric person ID in your token's organization.

type string Required

todo; event entries do not support this lookup on this resource.

entry integer Required

The event or to-do ID from entry details.

Query parameters#

kind string Required

users for to-do assignees.

page integer Optional

Page number, starting at 1; defaults to 1.

per_page integer Optional

Results per page, from 1 to 100; defaults to 25.

search string Optional

Filter matching names or record details. Up to 255 characters; surrounding whitespace is trimmed. Omit or send an empty value for all eligible choices.

Example#

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

curl --request GET "https://my.assetcenter.app/api/v1/people/123/timeline/todo/901/options?kind=users&search=Alex" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json"

Response#

200 OK. Each choice contains only id and name. The API includes additional pagination links and metadata.

{
  "data": [
    {
      "id": 4,
      "name": "Alex Smith"
    }
  ],
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 1
  }
}

Behavior and constraints#

The entry must be finalized, belong to this record, and be in your token's organization. Drafts, foreign entries, unrelated entries, and mismatched entry types or lookup kinds return 404. Unsupported kind values return 422.

Assignee choices include organization members, including inactive members. Search and pagination follow the corresponding users lookup. Unknown query fields, tenant_id, account_id, and location_id are rejected.

Send the chosen ID in an editable field such as assigned_to when updating the entry. Retrieve the entry first to see which fields it offers.

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 entry is unavailable through this path. 422 identifies invalid or unsupported input; inspect the errors object. 429 means a rate limit was reached. See error handling and rate limits.