List Guest Badges

GET 
/guest.badge.list

List issued Guest Badges.

Organization tokens return every issued badge in the workspace. Personal tokens return only badges the token owner issued. This is the issued (host) view — the same rows guest.badge.create returns — not the guest's hidden-inbox view.

Filter with email (alias-aware) and/or hostUserId (UUID or member email). Paginate with limit / cursor (default 50, max 100). Results are sorted by (hostUserId, email).

Organization keys that only have guest:write must also request guest:read to call list. Personal Access Tokens with pat:guests:write already include guest:read.

Access: Organization and Personal. Personal tokens naming a different host return 403 access_mode_not_supported.

Required scope: guest:read. Personal Access Tokens use the pat:guests:write group.

See Guest Badges.

---

OpenAPI Spec: chat-v1.json

Request

Responses

200

Issued Guest Badges for this page.

400

Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.

401

Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.

403

Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.

404

Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.

405

Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.

500

Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.