Sign in
Actors

Resolve actor names by id

Changed on

Resolve user and agent ids to display names for any signed-in caller.

Returns only id, actor_type, name and active for the ids asked for, so a caller without users:read can label the owners, approvers and actors it already sees by id. Users resolve for any caller; agents only when the caller may see them (its own agents, itself, or with owner:agents:read its owner's agents; every agent for org:admin). Ids that match no visible user or agent are left out of the response rather than reported as errors. Listing the whole directory stays behind users:read on GET /actors.

get/actors/lookup

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /actors/lookup
  • Auth: HTTP bearer

Query parameters

idstring[] required

Actor id to resolve; repeat the parameter for several ids (at most 100 per call, each at most 64 characters).

Response

Successful Response

Example response

{
  "data": [
    {
      "active": true,
      "actor_type": "user",
      "id": "usr_2abc",
      "name": "Ada Lovelace"
    }
  ]
}

Changes