dataz.md
Log in Get started

Discord API reference

List guild roles

Crawlable reference for GET /guilds/{guild_id}/roles through a dataz.md tenant gateway.

Purpose

GET/guilds/{guild_id}/roles

List all roles in a guild, sorted by position (highest first).

Returns role IDs, names, colors, and positions. IDs are returned as strings to prevent JavaScript precision loss.

Use /guilds/{guild_id}/roles/{role_name}/members to get members for a role.

  • guild_id: Discord guild ID
Category: Guilds Auth: Authorization bearer or X-API-Key Scope: read-only

Authentication

Send a tenant API key as Authorization: Bearer <key> or X-API-Key: <key>. Keep keys server-side and use the account slug for the connected Discord account.

Read the gateway authentication tutorial.

Parameters

NameInRequiredType / constraints
guild_id path required integer

Request example

Replace the tenant, account, and resource placeholders before running this read-only request.

curl --fail-with-body \
  -H "Authorization: Bearer ${DATAZ_API_KEY}" \
  "https://dataz.md/gateway/v1/{tenant_slug}/accounts/{account_slug}/guilds/{guild_id}/roles"

Response schema

Documented responses
200Response model: List[Role]List[Role]

Response example

Representative JSON shape. The live response can include additional documented fields.

[
  {
    "id": "123456789012345678",
    "name": "Example role",
    "color": 5793266,
    "position": 1
  }
]

Errors

Common responses
401Missing or invalid tenant API key.authentication
403The tenant, account, or connected provider cannot access the requested resource.authorization
404The route or requested provider resource was not found.not found
422A path or query parameter is invalid.validation
429Rate limited; wait for the Retry-After interval before retrying.rate limit

Limits and pagination

  • This endpoint does not expose cursor pagination in its current public contract.
  • Provider or demo limits can return HTTP 429. Wait for the Retry-After interval before retrying.

Related tutorials

Read-only notes

This reference page documents a public GET endpoint. Setup/token, AI, dev, internal, and mutating routes are excluded from static reference generation.