Skip to content

IArchetypes

v1 stable

/IArchetypes/v1/

List and inspect archetypes (roles) in a space. Permissions are hidden unless the bot has ManageArchetype entitlement.

Authentication required

All endpoints require Authorization: Bot <token> header. Get a token →

GET /IArchetypes/v1/Get

Gets a single archetype by ID.

Query Parameters

Field Type
spaceId
uuid
archetypeId
uuid

Response BotArchetypeV1

Field Type
archetypeId uuid
spaceId uuid
name string
colour int32
isMentionable boolean
isDefault boolean
permissions int64 | null

Errors

Status Code Description
400 missing_space_id spaceId is required.
403 not_a_member Bot is not a member of this space.
404 not_found Archetype not found.

Example

curl -X GET \
     -H "Authorization: Bot YOUR_TOKEN" \
     "https://gateway.argon.zone/IArchetypes/v1/Get?spaceId=...&archetypeId=..."
GET /IArchetypes/v1/List

Lists all archetypes in a space. Returns id, name, colour, isMentionable, isDefault. Permissions are included only if the bot has the ManageArchetype entitlement.

Query Parameters

Field Type
spaceId
uuid

Response ArchetypeListResponse

Field Type
archetypes BotArchetypeV1[]
↳ archetypeId uuid
↳ spaceId uuid
↳ name string
↳ colour int32
↳ isMentionable boolean
↳ isDefault boolean
↳ permissions int64 | null

Errors

Status Code Description
400 missing_space_id spaceId is required.
403 not_a_member Bot is not a member of this space.

Example

curl -X GET \
     -H "Authorization: Bot YOUR_TOKEN" \
     "https://gateway.argon.zone/IArchetypes/v1/List?spaceId=..."
GET /IArchetypes/v1/ListMembers

Lists all members assigned to a specific archetype.

Query Parameters

Field Type
spaceId
uuid
archetypeId
uuid

Response ArchetypeMembersResponse

Field Type
archetypeId uuid
members ArchetypeMemberV1[]
↳ userId uuid
↳ username string
↳ displayName string

Errors

Status Code Description
400 missing_space_id spaceId is required.
403 not_a_member Bot is not a member of this space.
404 not_found Archetype not found.

Example

curl -X GET \
     -H "Authorization: Bot YOUR_TOKEN" \
     "https://gateway.argon.zone/IArchetypes/v1/ListMembers?spaceId=...&archetypeId=..."