get/discovery/guilds

Search discoverable guilds

Search for guilds listed in the discovery directory.

search_discovery_guilds

Parameters

Name	In	Type
query	query	string
category	query	integer
language	query	string
tag	query	string
sort_by	query	string
limit	query	integer
offset	query	integer

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "guilds": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]*)$",
            "description": "Guild ID"
          },
          "name": {
            "type": "string",
            "description": "Guild name"
          },
          "icon": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Guild icon hash"
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Discovery description"
          },
          "category_type": {
            "type": "number",
            "description": "Discovery category type"
          },
          "primary_language": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Primary community language"
          },
          "custom_tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Custom discovery tags"
          },
          "member_count": {
            "type": "number",
            "description": "Approximate member count"
          },
          "online_count": {
            "type": "number",
            "description": "Approximate online member count"
          },
          "features": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Guild feature flags"
          },
          "verification_level": {
            "type": "number",
            "description": "Verification level"
          }
        },
        "required": [
          "id",
          "name",
          "category_type",
          "custom_tags",
          "member_count",
          "online_count",
          "features",
          "verification_level"
        ]
      },
      "description": "Discovery guild results"
    },
    "total": {
      "type": "number",
      "description": "Total number of matching guilds"
    }
  },
  "required": [
    "guilds",
    "total"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}