Guild

GET/api/v1/guilds

List_guilds

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query applied to guild name and description

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field (created_at, member_count, level, name)

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

filter?array<string>

Additional filter expressions in the form field:operator:value

public_only?boolean

Only return public guilds

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/guilds"

{  "guilds": [    {      "_relations": {        "property1": {          "has_more": true,          "returned": 0,          "total": 0        },        "property2": {          "has_more": true,          "returned": 0,          "total": 0        }      },      "applications": [        {          "application_id": "string",          "guild_id": "string",          "status": "pending",          "submitted_at": "2019-08-24T14:15:22Z",          "user_id": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "description": "string",      "guild_id": "string",      "join_policy": "open",      "level": 0,      "max_members": 0,      "member_count": 0,      "members": [        {          "guild_id": "string",          "joined_at": "2019-08-24T14:15:22Z",          "metadata": null,          "role": "leader",          "user_id": "string",          "xp_contributed": 0        }      ],      "metadata": null,      "name": "string",      "updated_at": "2019-08-24T14:15:22Z",      "visibility": "public",      "xp": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/guilds

Create_guild

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

created_by*string

User ID of the creator

description?|

Optional description

join_policy?null|

name*string

Name of the guild

visibility?null|

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds" \  -H "Content-Type: application/json" \  -d '{    "created_by": "string",    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "guild_id": "string",  "name": "string"}

GET/api/v1/guilds/{guild_id}

Get_guild

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Query Parameters

include?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/guilds/string"

{  "_relations": {    "property1": {      "has_more": true,      "returned": 0,      "total": 0    },    "property2": {      "has_more": true,      "returned": 0,      "total": 0    }  },  "applications": [    {      "application_id": "string",      "guild_id": "string",      "status": "pending",      "submitted_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "guild_id": "string",  "join_policy": "open",  "level": 0,  "max_members": 0,  "member_count": 0,  "members": [    {      "guild_id": "string",      "joined_at": "2019-08-24T14:15:22Z",      "metadata": null,      "role": "leader",      "user_id": "string",      "xp_contributed": 0    }  ],  "metadata": null,  "name": "string",  "updated_at": "2019-08-24T14:15:22Z",  "visibility": "public",  "xp": 0}

DELETE/api/v1/guilds/{guild_id}

Delete_guild

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/guilds/string"

{  "guild_id": "string",  "message": "string"}

PUT/api/v1/guilds/{guild_id}

Update_guild

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?|

New description

name?|

New name for the guild

visibility?null|

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/guilds/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "guild_id": "string",  "name": "string",  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/guilds/{guild_id}/applications

List_applications

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/guilds/string/applications"

{  "applications": [    {      "application_id": "string",      "guild_id": "string",      "status": "pending",      "submitted_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ],  "count": 0}

POST/api/v1/guilds/{guild_id}/applications/{application_id}/approve

Approve_application

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

application_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/applications/string/approve"

{  "guild_id": "string",  "joined_at": "2019-08-24T14:15:22Z",  "metadata": null,  "role": "leader",  "user_id": "string",  "xp_contributed": 0}

POST/api/v1/guilds/{guild_id}/applications/{application_id}/reject

Reject_application

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

application_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/applications/string/reject"

{  "application_id": "string",  "guild_id": "string",  "status": "pending",  "submitted_at": "2019-08-24T14:15:22Z",  "user_id": "string"}

GET/api/v1/guilds/{guild_id}/bank

Get_bank_balance

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/guilds/string/bank"

{  "available": 0,  "balance": 0,  "currency": "string",  "guild_id": "string",  "held": 0}

POST/api/v1/guilds/{guild_id}/bank/deposit

Bank_deposit

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer

Amount to move, in the guild currency's smallest unit

Formatint64

idempotency_key?|

Optional idempotency key for safe retries

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/bank/deposit" \  -H "Content-Type: application/json" \  -d '{    "amount": 0  }'

{  "available": 0,  "balance": 0,  "currency": "string",  "guild_id": "string",  "held": 0}

POST/api/v1/guilds/{guild_id}/bank/withdraw

Bank_withdraw

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer

Amount to move, in the guild currency's smallest unit

Formatint64

idempotency_key?|

Optional idempotency key for safe retries

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/bank/withdraw" \  -H "Content-Type: application/json" \  -d '{    "amount": 0  }'

{  "available": 0,  "balance": 0,  "currency": "string",  "guild_id": "string",  "held": 0}

GET/api/v1/guilds/{guild_id}/invitations

List_invitations

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/guilds/string/invitations"

{  "count": 0,  "invitations": [    {      "created_at": "2019-08-24T14:15:22Z",      "guild_id": "string",      "invitation_id": "string",      "invited_by": "string",      "invited_user_id": "string",      "status": "pending"    }  ]}

POST/api/v1/guilds/{guild_id}/invitations

Create_invitation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

invited_user_id*string

User ID being invited to the guild

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "invited_user_id": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "guild_id": "string",  "invitation_id": "string",  "invited_by": "string",  "invited_user_id": "string",  "status": "pending"}

POST/api/v1/guilds/{guild_id}/invitations/{invitation_id}/accept

Accept_invitation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

invitation_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/invitations/string/accept"

{  "guild_id": "string",  "joined_at": "2019-08-24T14:15:22Z",  "metadata": null,  "role": "leader",  "user_id": "string",  "xp_contributed": 0}

POST/api/v1/guilds/{guild_id}/invitations/{invitation_id}/decline

Decline_invitation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

invitation_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/invitations/string/decline"

{  "created_at": "2019-08-24T14:15:22Z",  "guild_id": "string",  "invitation_id": "string",  "invited_by": "string",  "invited_user_id": "string",  "status": "pending"}

POST/api/v1/guilds/{guild_id}/join

Join_guild

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

user_id*string

User ID joining the guild

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/join" \  -H "Content-Type: application/json" \  -d '{    "user_id": "string"  }'

{  "application_id": "string",  "guild_id": "string",  "joined_at": "2019-08-24T14:15:22Z",  "role": null,  "status": "pending",  "user_id": "string"}

POST/api/v1/guilds/{guild_id}/leave

Leave_guild

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

user_id*string

User ID leaving the guild

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/leave" \  -H "Content-Type: application/json" \  -d '{    "user_id": "string"  }'

{  "message": "string"}

GET/api/v1/guilds/{guild_id}/members

List_members

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/guilds/string/members"

{  "count": 0,  "members": [    {      "guild_id": "string",      "joined_at": "2019-08-24T14:15:22Z",      "metadata": null,      "role": "leader",      "user_id": "string",      "xp_contributed": 0    }  ]}

GET/api/v1/guilds/{guild_id}/members/{user_id}

Get_member

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

user_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/guilds/string/members/string"

{  "guild_id": "string",  "joined_at": "2019-08-24T14:15:22Z",  "metadata": null,  "role": "leader",  "user_id": "string",  "xp_contributed": 0}

POST/api/v1/guilds/{guild_id}/members/{user_id}/kick

Kick_member

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

user_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/guilds/string/members/string/kick"

{  "message": "string"}

PUT/api/v1/guilds/{guild_id}/members/{user_id}/role

Update_member_role

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

guild_id*string

user_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*MemberRole

New role for the member

Value in

"leader"
"officer"
"member"

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/guilds/string/members/string/role" \  -H "Content-Type: application/json" \  -d '{    "role": "leader"  }'

{  "guild_id": "string",  "joined_at": "2019-08-24T14:15:22Z",  "metadata": null,  "role": "leader",  "user_id": "string",  "xp_contributed": 0}

Guild

200application/json

503

201application/json

400

503

200application/json

404

503

200application/json

404

503

200application/json

400

404

503

200application/json

403

404

503

200application/json

403

404

409

503

200application/json

403

404

409

503

200application/json

403

404

503

200application/json

400

403

404

503

200application/json

400

403

404

409

503

200application/json

403

404

503

201application/json

403

404

409

503

200application/json

403

404

409

503

200application/json

403

404

409

503

200application/json

404

409

503

200application/json

404

503

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`