API Reference

Raids

List and view raid events scoped to your organizations.

Required Scope:raids:read

Note

Raids are organization-scoped. You can only view raids for organizations where you are a member or owner. The API automatically filters results to only show raids you have access to.

List Raids

GET/api/v1/raids

Returns a paginated list of raids across all organizations you belong to. Automatically scoped to your memberships.

Query Parameters

Parameter	Type	Required	Description
`page`	`integer`	Optional	Page number (default: 1)
`per_page`	`integer`	Optional	Results per page, max 100 (default: 25)
`sort`	`string`	Optional	Sort field: created_at, scheduled_at, title
`direction`	`string`	Optional	Sort direction: asc or desc (default: desc)
`filter[status]`	`string`	Optional	Filter by status: scheduled, in_progress, completed, cancelled
`filter[organization_id]`	`uuid`	Optional	Filter to a specific organization

Example Requestbash

curl "https://readyraider.com/api/v1/raids?filter[status]=scheduled&sort=scheduled_at&direction=asc" \
  -H "Authorization: Bearer rr_live_your_key"

Response (200 OK)json

{
  "data": [
    {
      "id": "raid-uuid",
      "organization_id": "org-uuid",
      "title": "Weekly WoW Raid Night",
      "description": "Heroic raid clear, all roles welcome.",
      "game_id": "wow",
      "scheduled_at": "2026-02-15T20:00:00Z",
      "duration_minutes": 180,
      "signup_deadline": "2026-02-15T18:00:00Z",
      "roles": {
        "tank": { "min": 2, "max": 2 },
        "healer": { "min": 4, "max": 5 },
        "dps": { "min": 13, "max": 18 }
      },
      "max_participants": 25,
      "allow_bench": true,
      "status": "scheduled",
      "created_by": "user-uuid",
      "created_at": "2026-02-10T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 3,
    "total_pages": 1
  }
}

Tip

If you belong to multiple organizations, use filter[organization_id] to narrow results to a single org.

Get Raid

GET/api/v1/raids/:id

Returns a single raid by ID. You must be a member or owner of the raid's organization.

Path Parameters

Parameter	Type	Required	Description
`id`	`uuid`	Required	Raid UUID

Example Requestbash

curl "https://readyraider.com/api/v1/raids/raid-uuid" \
  -H "Authorization: Bearer rr_live_your_key"

Response (200 OK)json

{
  "data": {
    "id": "raid-uuid",
    "organization_id": "org-uuid",
    "title": "Weekly WoW Raid Night",
    "description": "Heroic raid clear, all roles welcome. Bring consumables and be on time.",
    "game_id": "wow",
    "scheduled_at": "2026-02-15T20:00:00Z",
    "duration_minutes": 180,
    "signup_deadline": "2026-02-15T18:00:00Z",
    "recurrence_rule": "FREQ=WEEKLY;BYDAY=SA",
    "roles": {
      "tank": { "min": 2, "max": 2 },
      "healer": { "min": 4, "max": 5 },
      "dps": { "min": 13, "max": 18 }
    },
    "max_participants": 25,
    "allow_bench": true,
    "auto_promote_waitlist": true,
    "status": "scheduled",
    "created_by": "user-uuid",
    "created_at": "2026-02-10T12:00:00Z",
    "updated_at": "2026-02-10T12:00:00Z"
  }
}

Note

The roles field is a JSON object mapping role names to their min/max participant counts. The structure is flexible and depends on the game.

PreviousOrganizations API

NextAccount API