FruxonDocs
ApiPeople

Looks people up by user id or participant id.

Returns one result for each distinct id asked about, echoing that id beside the person it names, so each answer can be matched to its request whatever kind of person comes back. A user id can name a workspace member, a user who is no longer a member here (`former`, with no name or avatar), or the system user (`SYSTEM`). A participant id names a participant only for a caller holding `participants:read`. Any id that names nobody the caller can see comes back `UNKNOWN`. Names and avatars are already resolved, as everywhere else people are shown. At most 100 ids per call; more is a 400.

GET
/v1/tenants/{tenant}/people:lookup

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

tenant*string

The tenant identifier

Query Parameters

userIds?array<string>

Members' user ids, repeated: ?userIds=a&userIds=b.

participantIds?array<string>

Participant ids, repeated: ?participantIds=a&participantIds=b.

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/people:lookup"
{
  "results": [
    {
      "userId": "string",
      "participantId": "00000000-0000-0000-0000-000000000000",
      "person": {
        "kind": "UNSPECIFIED",
        "participantId": null,
        "userId": "string",
        "displayName": "string",
        "participantKind": null,
        "agentId": "string",
        "avatarFileId": "string",
        "former": false
      }
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}