Skip to main content
GET
Get World Change

Authorizations

Authorization
string
header
required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Path Parameters

id
string
required

World ID.

Pattern: ^wld_[0-9A-HJKMNP-TV-Z]{26}$
change_id
string
required

Membership change ID.

Pattern: ^wch_[0-9A-HJKMNP-TV-Z]{26}$

Response

OK

completed_at
string<date-time> | null
required

Time the change completed or failed, or null while it runs.

created_at
string<date-time>
required

Change creation time.

delete
boolean
required

Whether a removed member is deleted rather than detached.

error
object | null
required

Safe failure information, or null when no failure is recorded.

id
string
required

Membership change ID.

Pattern: ^wch_[0-9A-HJKMNP-TV-Z]{26}$
kind
enum<string>
required

add adds a member; remove detaches or deletes one.

Available options:
add,
remove
simulation
object
required

The member this change adds or removes.

status
enum<string>
required

Durable change state. Poll while pending, building, or applying.

Available options:
pending,
building,
applying,
completed,
failed
world_id
string
required

World ID.

Pattern: ^wld_[0-9A-HJKMNP-TV-Z]{26}$