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.

54ffb425be28ff6f… SHA-256 contract hash — guaranteed stable

Authentication required

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

GET /IArchetypes/v1/Get

Gets a single archetype by ID. Pass spaceId and archetypeId as query parameters.

Response BotArchetypeV1

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

Errors

Status Code Description
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
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.

Response ArchetypeListResponse

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

Errors

Status Code Description
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
GET /IArchetypes/v1/ListMembers ViewMembers

Lists all members assigned to a specific archetype. Pass spaceId and archetypeId as query parameters.

Response ArchetypeMembersResponse

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

Errors

Status Code Description
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/ListMembers