Developer docs · API reference
API reference
All 182 documented operations, generated from the route contracts. Each lists who may call it, its parameters, body, responses and error codes. Shared types are on the Schemas page.
Public
The public catalog, shops and profiles. No sign-in needed.
Public catalog7
- GET
/api/v1/public/catalogThe catalog home - GET
/api/v1/public/catalog/issues/{id}/listingsShops’ copies of an issue - GET
/api/v1/public/catalog/new-releasesNew releases - GET
/api/v1/public/catalog/publishers/{slug}A publisher or imprint - GET
/api/v1/public/catalog/searchSearch the public catalog - GET
/api/v1/public/catalog/series/{slug}A series - GET
/api/v1/public/catalog/series/{slug}/{issue}An issue
Collectors
A signed-in collector’s own collection, scans, insights and account.
Assistant7
- GET
/api/v1/assistantWhether the assistant can answer · beta - POST
/api/v1/assistantSend a message · beta - POST
/api/v1/assistant/previewPreview a proposed change · beta - GET
/api/v1/assistant/threadsYour conversations · beta - GET
/api/v1/assistant/threads/{id}A conversation · beta - DELETE
/api/v1/assistant/threads/{id}Delete a conversation · beta - PATCH
/api/v1/assistant/threads/{id}Rename or pin a conversation · beta
Catalog7
- GET
/api/v1/catalog/barcodeLook up a barcode - POST
/api/v1/catalog/identifyIdentify a book from evidence - GET
/api/v1/catalog/issues/{id}Get an issue · beta - POST
/api/v1/catalog/materializeBring a candidate into the catalog - POST
/api/v1/catalog/provisionalAdd a book no source knows yet - GET
/api/v1/catalog/searchSearch the catalog - GET
/api/v1/catalog/series/{slug}/goGo to an issue of a series
Catalog contributions11
- GET
/api/v1/catalog/correctionsList your corrections to a record - POST
/api/v1/catalog/correctionsSuggest a correction - POST
/api/v1/catalog/corrections/{id}/withdrawWithdraw a correction - GET
/api/v1/catalog/cover-contributionsList your cover photos - POST
/api/v1/catalog/cover-contributionsSend a cover photo - DELETE
/api/v1/catalog/cover-contributions/{id}Withdraw a cover photo - GET
/api/v1/catalog/covers-wantedYour copies whose issue has no cover - GET
/api/v1/catalog/variant-covers-wantedYour variants with no cover of their own - GET
/api/v1/catalog/variant-proposalsList your variant proposals - POST
/api/v1/catalog/variant-proposalsPropose a variant - DELETE
/api/v1/catalog/variant-proposals/{id}Withdraw a variant proposal
Collection11
- GET
/api/v1/collection/exportExport the collection - POST
/api/v1/collection/imports/{id}/undoUndo an import - GET
/api/v1/collection/items/{id}/changesA copy’s history - POST
/api/v1/collection/items/{id}/changes/{changeId}/undoUndo a change to a copy - GET
/api/v1/collection/items/{id}/codesThe codes on a copy - POST
/api/v1/collection/items/{id}/codesAdd a code to a copy - DELETE
/api/v1/collection/items/{id}/codes/{codeId}Remove a code from a copy - POST
/api/v1/collection/items/{id}/codes/checkCheck a code against a copy - GET
/api/v1/collection/items/{id}/repointSuggest what a copy could be - POST
/api/v1/collection/items/{id}/repointChange what a copy is - POST
/api/v1/collection/items/bulkChange many copies at once
Holds8
- GET
/api/v1/holdsList my holds - POST
/api/v1/holdsAsk a store to hold a book - POST
/api/v1/holds/{holdId}/cancelCancel a hold - POST
/api/v1/holds/{holdId}/completeRecord the sale - POST
/api/v1/holds/{holdId}/confirmConfirm the purchase - GET
/api/v1/holds/{holdId}/messagesRead a hold’s messages - POST
/api/v1/holds/{holdId}/messagesMessage about a hold - POST
/api/v1/holds/{holdId}/respondAccept or decline a hold request
Questions6
- GET
/api/v1/questionsList my questions to stores - POST
/api/v1/questionsAsk a store about a book - POST
/api/v1/questions/{questionId}/closeClose a question - POST
/api/v1/questions/{questionId}/holdSet the book aside for the asker - GET
/api/v1/questions/{questionId}/messagesRead a question’s thread - POST
/api/v1/questions/{questionId}/messagesReply in a question’s thread
Scans12
- POST
/api/v1/scansCreate a scan - DELETE
/api/v1/scans/{id}Delete a scan - PATCH
/api/v1/scans/{id}Update a scan - POST
/api/v1/scans/{id}/addAdd a scan to the collection - POST
/api/v1/scans/{id}/processMatch a scan - POST
/api/v1/scans/{id}/provisionalAdd a missing book for a scan - GET
/api/v1/scans/{id}/searchSearch for a scan - POST
/api/v1/scans/batchesStart a scanning session - PATCH
/api/v1/scans/batches/{id}Update a scanning session - POST
/api/v1/scans/bulkAct on many scans - GET
/api/v1/scans/searchSearch before scanning - POST
/api/v1/scans/upload-urlGet upload URLs for a scan’s photo
Stores
Running a shop: inventory, holds, questions and the team.
Store inventory9
- POST
/api/v1/stores/{storeId}/import/commitImport inventory rows - POST
/api/v1/stores/{storeId}/import/previewPreview an inventory CSV - GET
/api/v1/stores/{storeId}/listingsList the store’s inventory - POST
/api/v1/stores/{storeId}/listingsList a book - GET
/api/v1/stores/{storeId}/listings/{listingId}Get a listing - DELETE
/api/v1/stores/{storeId}/listings/{listingId}Delete a listing - PATCH
/api/v1/stores/{storeId}/listings/{listingId}Update a listing - POST
/api/v1/stores/{storeId}/listings/bulkSet many listings’ status - GET
/api/v1/stores/catalog-searchFind a book to list
Store team8
- GET
/api/v1/store-invitesList my team invitations - POST
/api/v1/store-invites/{inviteId}/respondAccept or decline an invitation - GET
/api/v1/stores/{storeId}/membersList the store’s team - DELETE
/api/v1/stores/{storeId}/members/{userId}Remove a member, or leave - PATCH
/api/v1/stores/{storeId}/members/{userId}Change a member’s role - GET
/api/v1/stores/{storeId}/members/invitesList open invitations - POST
/api/v1/stores/{storeId}/members/invitesInvite someone to the team - DELETE
/api/v1/stores/{storeId}/members/invites/{inviteId}Withdraw an invitation
Admin
Catalog editing, moderation, imports and operations. Admins and moderators only.
Admin catalog14
- GET
/api/v1/admin/catalogFind catalog records to edit · beta - GET
/api/v1/admin/catalog/{entity}/{id}Get a catalog record · beta - PATCH
/api/v1/admin/catalog/{entity}/{id}Edit a catalog record · beta - POST
/api/v1/admin/catalog/{entity}/{id}/imprintsAdd an imprint to a publisher · beta - POST
/api/v1/admin/catalog/{entity}/{id}/locksLock or unlock a field · beta - POST
/api/v1/admin/catalog/{entity}/{id}/slugChange a series or issue slug · beta - POST
/api/v1/admin/catalog/{entity}/{id}/verifyVerify a provisional record · beta - GET
/api/v1/admin/catalog/edition-overrides/{id}An edition’s overridden fields · beta - POST
/api/v1/admin/catalog/edition-overrides/{id}/revertRevert an overridden field · beta - GET
/api/v1/admin/catalog/issue-overrides/{id}Overridden fields per edition of an issue · beta - POST
/api/v1/admin/catalog/movesMove issues to another series · beta - POST
/api/v1/admin/catalog/moves/{id}/undoUndo an issue move · beta - POST
/api/v1/admin/catalog/moves/previewPreview moving issues to another series · beta - POST
/api/v1/admin/catalog/override-reverts/{id}/undoUndo a revert · beta
Admin imports5
- GET
/api/v1/admin/importsImport jobs · beta - GET
/api/v1/admin/imports/conflictsImport identity conflicts · beta - GET
/api/v1/admin/imports/conflicts/{id}One import conflict in full · beta - POST
/api/v1/admin/imports/conflicts/{id}Resolve an import conflict · beta - POST
/api/v1/admin/imports/syncStart a Metron sync now · beta
Admin moderation10
- GET
/api/v1/admin/code-proposalsCodes collectors added · beta - POST
/api/v1/admin/code-proposals/{id}Approve or decline a code · beta - GET
/api/v1/admin/cover-contributionsCollectors’ cover photos · beta - POST
/api/v1/admin/cover-contributions/{id}Approve or decline a cover photo · beta - GET
/api/v1/admin/moderationCatalog change requests · beta - POST
/api/v1/admin/moderation/{id}Approve or reject a change request · beta - GET
/api/v1/admin/variant-proposalsVariant proposals and import suggestions · beta - POST
/api/v1/admin/variant-proposals/{id}Approve or decline a variant proposal · beta - POST
/api/v1/admin/variant-proposals/{id}/resolveResolve an import suggestion · beta - POST
/api/v1/admin/variant-proposals/{id}/undoUndo an assigned import suggestion · beta
Admin operations12
- GET
/api/v1/admin/announcementsAnnouncements · beta - POST
/api/v1/admin/announcementsPublish or schedule an announcement · beta - PATCH
/api/v1/admin/announcements/{id}Edit an announcement · beta - POST
/api/v1/admin/announcements/{id}/endTake an announcement down now · beta - GET
/api/v1/admin/auditAudit log · beta - GET
/api/v1/admin/coverageCover coverage · beta - GET
/api/v1/admin/healthIncidents, cron jobs and capacity · beta - PATCH
/api/v1/admin/health/incidents/{id}Resolve or reopen an incident · beta - GET
/api/v1/admin/overviewAdmin overview counts · beta - GET
/api/v1/admin/settingsPlatform settings · beta - PUT
/api/v1/admin/settingsChange platform settings · beta - GET
/api/v1/admin/usageProduct analytics · beta
Admin people and stores12
- GET
/api/v1/admin/plansPlan grants · beta - POST
/api/v1/admin/plansGive someone a plan · beta - POST
/api/v1/admin/plans/{id}/revokeEnd a plan grant now · beta - GET
/api/v1/admin/reportsAbuse reports · beta - POST
/api/v1/admin/reports/{id}Decide a report · beta - POST
/api/v1/admin/reports/{id}/restoreUndo “hide content” for a report · beta - GET
/api/v1/admin/storesStores · beta - PATCH
/api/v1/admin/stores/{id}Verify, suspend or set a store’s fee · beta - GET
/api/v1/admin/supportSupport messages · beta - PATCH
/api/v1/admin/support/{id}Close or reopen a support message · beta - GET
/api/v1/admin/usersSearch people · beta - PATCH
/api/v1/admin/users/{id}Change someone’s role or access · beta