Read Rosters

The canonical persona roster with its presentation config.

Global reference data, ~20 rows. The frontend renders persona cards, orders them, and resolves a persona name out of an agent title from this, so adding a persona is a row insert rather than a matching TypeScript edit.

get/agents/rosters

Request

Base URL
https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or HTTP bearer

Query parameters

public_onlyboolean

Headers

organization-idstring nullable

x-user-idstring nullable

timezonestring

x-actor-emailstring nullable

x-request-sourcestring nullable

x-operation-idstring nullable

x-commit-messagestring nullable

x-confirmation-idstring nullable

x-chat-idstring nullable

Response

Successful Response

idstring required

keystring required

display_namestring required

sort_orderinteger required

display_rolestring nullable

display_iconstring nullable

display_colorstring nullable

descriptionstring nullable

is_campaign_personaboolean

is_visible_in_dashboardboolean

Changes

No recorded changes to this operation across all 1 revision of this API.