# EPGP

## `POST /api/epgp/adjustments`

**CreateAdjustment**

**Request body**

Model: {ref}`EpgpAdjustmentCreate <model-epgpadjustmentcreate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `member_id` | integer | yes |  |
| `kind` | {ref}`LedgerKind <model-ledgerkind>` | yes |  |
| `amount` | integer | yes |  |
| `reason` | string | yes |  |

**Response `201` — Document created, URL follows**

Model: {ref}`EpgpLedgerRow <model-epgpledgerrow>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `at` | string (date-time) | yes |  |
| `kind` | {ref}`LedgerKind <model-ledgerkind>` | yes |  |
| `amount` | integer | yes |  |
| `decayed` | number | yes |  |
| `reason` | string | yes |  |
| `note` | string \| null | yes |  |
| `character` | string \| null | yes |  |
| `member_id` | integer \| null | yes |  |
| `member_name` | string \| null | yes |  |
| `officer` | string | yes |  |
| `item_name` | string \| null | yes |  |
| `voided` | boolean | yes |  |


## `GET /api/epgp/characters`

**ListCharacters**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpCharacterList <model-epgpcharacterlist>`

| Field | Type | Required | Description |
|---|---|---|---|
| `characters` | array of {ref}`EpgpCharacter <model-epgpcharacter>` | yes |  |


## `PUT /api/epgp/characters/{character_id}`

**UpdateCharacter**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `character_id` | path | string (uuid) | yes |  |

**Request body**

Model: {ref}`EpgpCharacterUpdate <model-epgpcharacterupdate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `member_id` | integer \| null | yes |  |
| `is_main` | boolean | yes |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpCharacter <model-epgpcharacter>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `name` | string | yes |  |
| `realm` | string | yes |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | yes |  |
| `member_id` | integer \| null | yes |  |
| `member_name` | string \| null | yes |  |
| `is_main` | boolean | yes |  |
| `source` | {ref}`CharacterSource <model-charactersource>` | yes |  |
| `last_seen_at` | string (date-time) \| null | yes |  |


## `GET /api/epgp/game-import`

**GetGameImport**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpGameImport <model-epgpgameimport>`

| Field | Type | Required | Description |
|---|---|---|---|
| `payload` | string | yes |  |
| `generated_at` | string (date-time) | yes |  |


## `POST /api/epgp/imports`

**ImportPayload**

**Request body**

Model: {ref}`EpgpImportBody <model-epgpimportbody>`

| Field | Type | Required | Description |
|---|---|---|---|
| `payload` | string | yes |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpImportResult <model-epgpimportresult>`

| Field | Type | Required | Description |
|---|---|---|---|
| `recorder` | string | yes |  |
| `sessions` | {ref}`ImportCounts <model-importcounts>` | yes |  |
| `encounters` | {ref}`ImportCounts <model-importcounts>` | yes |  |
| `loot` | {ref}`LootImportCounts <model-lootimportcounts>` | yes |  |
| `awards` | {ref}`AwardImportCounts <model-awardimportcounts>` | yes |  |
| `unlinked_characters` | array of string | no |  |
| `attendance` | {ref}`ImportAttendanceResult <model-importattendanceresult>` | yes |  |
| `conflicts` | array of string | no |  |
| `roster` | {ref}`RosterImportCounts <model-rosterimportcounts>` | no |  |
| `professions` | {ref}`ProfessionImportCounts <model-professionimportcounts>` | no |  |
| `signups` | {ref}`SignupImportCounts <model-signupimportcounts>` | no |  |
| `bank` | {ref}`BankImportCounts <model-bankimportcounts>` | no |  |
| `announcements` | {ref}`AnnouncementImportCounts <model-announcementimportcounts>` | no |  |
| `recruits` | {ref}`RecruitImportCounts <model-recruitimportcounts>` | no |  |
| `member_notes` | {ref}`MemberNoteImportCounts <model-membernoteimportcounts>` | no |  |


## `GET /api/epgp/ledger`

**GetLedger**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `member_id` | query | integer \| null | no |  |
| `character` | query | string \| null | no |  |
| `limit` | query | integer | no |  |
| `before` | query | string (date-time) \| null | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpLedgerPage <model-epgpledgerpage>`

| Field | Type | Required | Description |
|---|---|---|---|
| `entries` | array of {ref}`EpgpLedgerRow <model-epgpledgerrow>` | yes |  |


## `GET /api/epgp/loot`

**GetLoot**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpLootPage <model-epgplootpage>`

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | array of {ref}`EpgpLootRow <model-epgplootrow>` | yes |  |


## `GET /api/epgp/member-notes`

**ListNotes**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `member_id` | query | integer \| null | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpMemberNoteList <model-epgpmembernotelist>`

| Field | Type | Required | Description |
|---|---|---|---|
| `notes` | array of {ref}`EpgpMemberNoteRow <model-epgpmembernoterow>` | yes |  |


## `GET /api/epgp/progression`

**GetProgression**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpProgression <model-epgpprogression>`

| Field | Type | Required | Description |
|---|---|---|---|
| `instances` | array of {ref}`EpgpProgressionInstance <model-epgpprogressioninstance>` | yes |  |


## `GET /api/epgp/recruits`

**ListRecruits**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpRecruitList <model-epgprecruitlist>`

| Field | Type | Required | Description |
|---|---|---|---|
| `recruits` | array of {ref}`EpgpRecruitRow <model-epgprecruitrow>` | yes |  |


## `PUT /api/epgp/recruits/{recruit_id}`

**UpdateRecruit**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `recruit_id` | path | string (uuid) | yes |  |

**Request body**

Model: {ref}`EpgpRecruitUpdate <model-epgprecruitupdate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `status` | {ref}`RecruitStatus <model-recruitstatus>` \| null | no |  |
| `note` | string \| null | no |  |
| `checklist` | {ref}`RecruitChecklist <model-recruitchecklist>` \| null | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpRecruitRow <model-epgprecruitrow>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `character` | string | yes |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | no |  |
| `status` | {ref}`RecruitStatus <model-recruitstatus>` | yes |  |
| `note` | string \| null | yes |  |
| `checklist` | {ref}`RecruitChecklist <model-recruitchecklist>` | yes |  |
| `votes` | array of {ref}`ExportRecruitVote <model-exportrecruitvote>` | yes |  |
| `member_id` | integer \| null | yes |  |
| `at` | string (date-time) | yes |  |


## `POST /api/epgp/recruits/{recruit_id}/votes`

**AddVote**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `recruit_id` | path | string (uuid) | yes |  |

**Request body**

Model: {ref}`EpgpRecruitVoteCreate <model-epgprecruitvotecreate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `vote` | {ref}`RecruitVoteChoice <model-recruitvotechoice>` | yes |  |

**Response `201` — Document created, URL follows**

Model: {ref}`EpgpRecruitRow <model-epgprecruitrow>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `character` | string | yes |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | no |  |
| `status` | {ref}`RecruitStatus <model-recruitstatus>` | yes |  |
| `note` | string \| null | yes |  |
| `checklist` | {ref}`RecruitChecklist <model-recruitchecklist>` | yes |  |
| `votes` | array of {ref}`ExportRecruitVote <model-exportrecruitvote>` | yes |  |
| `member_id` | integer \| null | yes |  |
| `at` | string (date-time) | yes |  |


## `GET /api/epgp/roster`

**GetRoster**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpRoster <model-epgproster>`

| Field | Type | Required | Description |
|---|---|---|---|
| `members` | array of {ref}`EpgpRosterRow <model-epgprosterrow>` | yes |  |


## `PUT /api/epgp/roster/{member_id}`

**UpdateRoster**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `member_id` | path | integer | yes |  |

**Request body**

Model: {ref}`EpgpRosterUpdate <model-epgprosterupdate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `raid_status` | {ref}`RaidStatus <model-raidstatus>` \| null | yes |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpRosterRow <model-epgprosterrow>`

| Field | Type | Required | Description |
|---|---|---|---|
| `member_id` | integer | yes |  |
| `name` | string | yes |  |
| `raid_status` | {ref}`RaidStatus <model-raidstatus>` \| null | yes |  |
| `trial_started_at` | string (date-time) \| null | yes |  |


## `GET /api/epgp/standings`

**GetStandings**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpStandings <model-epgpstandings>`

| Field | Type | Required | Description |
|---|---|---|---|
| `generated_at` | string (date-time) | yes |  |
| `rules` | {ref}`EpgpRules <model-epgprules>` | yes |  |
| `rows` | array of {ref}`EpgpStandingsRow <model-epgpstandingsrow>` | yes |  |


## `GET /api/epgp/sync-tokens`

**ListSyncTokens**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpSyncTokenList <model-epgpsynctokenlist>`

| Field | Type | Required | Description |
|---|---|---|---|
| `tokens` | array of {ref}`EpgpSyncTokenSummary <model-epgpsynctokensummary>` | yes |  |


## `POST /api/epgp/sync-tokens`

**CreateSyncToken**

**Request body**

Model: {ref}`EpgpSyncTokenCreate <model-epgpsynctokencreate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | yes |  |

**Response `201` — Document created, URL follows**

Model: {ref}`EpgpSyncTokenCreated <model-epgpsynctokencreated>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `name` | string | yes |  |
| `token` | string | yes |  |


## `DELETE /api/epgp/sync-tokens/{token_id}`

**RevokeSyncToken**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `token_id` | path | string (uuid) | yes |  |

**Response `204`** — Request fulfilled, nothing follows


## `GET /api/me/characters`

**ListMyCharacters**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EpgpCharacterList <model-epgpcharacterlist>`

| Field | Type | Required | Description |
|---|---|---|---|
| `characters` | array of {ref}`EpgpCharacter <model-epgpcharacter>` | yes |  |


## `POST /api/me/characters`

**ClaimCharacter**

**Request body**

Model: {ref}`MyCharacterCreate <model-mycharactercreate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | yes |  |
| `realm` | string \| null | no |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | no |  |

**Response `201` — Document created, URL follows**

Model: {ref}`EpgpCharacter <model-epgpcharacter>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `name` | string | yes |  |
| `realm` | string | yes |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | yes |  |
| `member_id` | integer \| null | yes |  |
| `member_name` | string \| null | yes |  |
| `is_main` | boolean | yes |  |
| `source` | {ref}`CharacterSource <model-charactersource>` | yes |  |
| `last_seen_at` | string (date-time) \| null | yes |  |


## `DELETE /api/me/characters/{character_id}`

**DeleteCharacter**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `character_id` | path | string (uuid) | yes |  |

**Response `204`** — Request fulfilled, nothing follows