Skip to content
The API may change between versions while TTX-Zone is 0.x.

List people

GET
/api/v1/ttx/{ttx_id}/people

Everyone on the exercise except its Players.

Successful Response

Media typeapplication/json
ExercisePeopleListResponse
object
items
required
Items
Array<object>
ExercisePersonRead

One row of the exercise’s people matrix.

object
added_at
required
Added At
string format: date-time
controls
required
Controls
boolean
email
required
Email
string
evaluates
Evaluates
boolean
facilitates
required
Facilitates
boolean
full_name
required
Full Name
string
grants
Grants
Array<string>
default:
Allowed values: planner observer evaluator
is_lead
required
Is Lead
boolean
last_login_at
Any of:
string format: date-time
leads
Leads
boolean
observes
Observes
boolean
org_tags
Org Tags
Array<object>
default:
OrganizationTagRead
object
applied
required
Applied
boolean
color
required
TagColor

Palette shared by both tag pools (Organization and TTX). The 8 original members plus TEAL/LIME/GRAPHITE are curated swatches chosen to stay clear of every color already carrying a fixed meaning elsewhere (–color-severity-*, –color-accent/-cta, -danger, -success) – see frontend/src/index.css for their exact hex. CUSTOM is the escape hatch: a tag with color=CUSTOM carries its real color in the sibling custom_hex field instead (validated by CUSTOM_HEX_PATTERN below) rather than a fixed token, at the cost of no contrast guarantee – the fixed swatches remain the safe default; CUSTOM is opt-in.

string
Allowed values: violet indigo fuchsia rose plum slate sand moss teal lime graphite custom
created_at
required
Created At
string format: date-time
custom_hex
required
Any of:
string
disabled_at
Any of:
string format: date-time
id
required
Id
string format: uuid
name
required
Name
string
origin
Any of:
ActorOrigin

Where a simulated actor comes from – the actor library’s levels. An exercise’s cast only holds copies; the origin says of what.

string
Allowed values: system organization exercise
origin_id
Any of:
string
<= 64 characters
origin_name
Any of:
string
<= 64 characters
usage_count
Usage Count
integer
0
plans
required
Plans
boolean
role
required
Role
string
Allowed values: planner observer evaluator
tags
Tags
Array<object>
default:
TTXTagRead
object
color
required
TagColor

Palette shared by both tag pools (Organization and TTX). The 8 original members plus TEAL/LIME/GRAPHITE are curated swatches chosen to stay clear of every color already carrying a fixed meaning elsewhere (–color-severity-*, –color-accent/-cta, -danger, -success) – see frontend/src/index.css for their exact hex. CUSTOM is the escape hatch: a tag with color=CUSTOM carries its real color in the sibling custom_hex field instead (validated by CUSTOM_HEX_PATTERN below) rather than a fixed token, at the cost of no contrast guarantee – the fixed swatches remain the safe default; CUSTOM is opt-in.

string
Allowed values: violet indigo fuchsia rose plum slate sand moss teal lime graphite custom
created_at
required
Created At
string format: date-time
custom_hex
required
Any of:
string
id
required
Id
string format: uuid
name
required
Name
string
origin
Any of:
ActorOrigin

Where a simulated actor comes from – the actor library’s levels. An exercise’s cast only holds copies; the origin says of what.

string
Allowed values: system organization exercise
origin_id
Any of:
string
<= 64 characters
origin_name
Any of:
string
<= 64 characters
user_id
required
User Id
string format: uuid

Example

{
"items": [
{
"evaluates": false,
"grants": [],
"leads": false,
"observes": false,
"org_tags": [],
"role": "planner",
"tags": []
}
]
}