get/discovery/guilds

Search discoverable guilds

Search for guilds listed in the discovery directory.

search_discovery_guilds

Parameters

NameInTypeDescription
queryquerystringSearch query
categoryqueryintegerFilter by category
languagequerystringFilter by primary community language
tagquerystringFilter by a specific custom tag
sort_byquerystringSort order
limitqueryintegerNumber of results to return
offsetqueryintegerPagination offset

Responses

200

Success

json
{
  "type": "object",
  "properties": {
    "guilds": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Guild ID",
            "$ref": "#/components/schemas/SnowflakeStringType"
          },
          "name": {
            "type": "string",
            "description": "Guild name"
          },
          "icon": {
            "description": "Guild icon hash",
            "type": [
              "string",
              "null"
            ]
          },
          "banner": {
            "description": "Guild banner hash",
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "description": "Discovery description",
            "type": [
              "string",
              "null"
            ]
          },
          "category_type": {
            "type": "number",
            "description": "Discovery category type"
          },
          "primary_language": {
            "description": "Primary community language",
            "type": [
              "string",
              "null"
            ]
          },
          "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"
        ],
        "additionalProperties": false
      },
      "description": "Discovery guild results"
    },
    "total": {
      "type": "number",
      "description": "Total number of matching guilds"
    },
    "category_counts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "category_type": {
            "type": "number",
            "description": "Discovery category type"
          },
          "count": {
            "type": "number",
            "description": "Number of matching guilds in this category"
          }
        },
        "required": [
          "category_type",
          "count"
        ],
        "additionalProperties": false
      },
      "description": "Match counts per category for the current filters, ignoring the category filter"
    }
  },
  "required": [
    "guilds",
    "total",
    "category_counts"
  ],
  "additionalProperties": false
}
400

Bad Request - The request was malformed or contained invalid data

json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}
401

Unauthorized - Authentication is required or the token is invalid

json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}
403

Forbidden - You do not have permission to perform this action

json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}
429

Too Many Requests - You are being rate limited

json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}
500

Internal Server Error - An unexpected error occurred

json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}