{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/versedb.com" } ], "info": { "name": "VerseDB API Documentation", "_postman_id": "4f0dd9e4-c891-4922-b86a-f4fa0dbd4ea3", "description": "REST API for accessing comic book data, managing collections, and building integrations with VerseDB.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Discovery", "description": "\nDynamic content discovery endpoints for the home screen and new releases.\n\nThese endpoints provide curated and time-sensitive content like upcoming releases,\nFOC (Final Order Cutoff) deadlines, and new first issues.", "item": [ { "name": "FOC deadlines.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/discovery\/foc", "query": [ { "key": "limit", "value": "10", "description": "Max results (1-50).", "disabled": false }, { "key": "days", "value": "7", "description": "FOC window in days (1-30).", "disabled": false }, { "key": "start_date", "value": "2026-03-15", "description": "Start of FOC window (YYYY-MM-DD). Defaults to today.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/discovery\/foc?limit=10&days=7&start_date=2026-03-15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"limit\":1,\"days\":22,\"start_date\":\"2026-07-02\"}" }, "description": "Returns issues with Final Order Cutoff (FOC) deadline within the next N days.\nFOC is when retailers must place final orders with distributors (typically 2 weeks before release)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5432,\n \"number\": \"1\",\n \"title\": \"Amazing Spider-Man\",\n \"cover_url\": \"...\",\n \"release_date\": \"2024-02-01\",\n \"foc_date\": \"2024-01-18\",\n \"series\": {\"id\": 123, \"name\": \"Amazing Spider-Man\"}\n }\n ],\n \"meta\": {\n \"foc_window_days\": 7,\n \"foc_start\": \"2024-01-15\",\n \"foc_end\": \"2024-01-22\",\n \"note\": \"FOC dates are estimates based on release_date - 14 days\"\n }\n}", "name": "Success" } ] }, { "name": "Upcoming #1 issues.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/discovery\/upcoming-firsts", "query": [ { "key": "limit", "value": "10", "description": "Max results (1-25).", "disabled": false }, { "key": "days", "value": "60", "description": "Lookahead window in days (1-90).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/discovery\/upcoming-firsts?limit=10&days=60" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"limit\":1,\"days\":22}" }, "description": "Returns upcoming first issues (#1) from new ongoing series within the next N days.\nUseful for discovering new series launches." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 9876,\n \"number\": \"1\",\n \"title\": \"New Series #1\",\n \"cover_url\": \"...\",\n \"release_date\": \"2024-02-15\",\n \"series\": {\n \"id\": 456,\n \"name\": \"New Series\",\n \"status\": \"ongoing\",\n \"publication_type\": \"regular\"\n }\n }\n ],\n \"meta\": {\n \"lookahead_days\": 60,\n \"window_start\": \"2024-01-15\",\n \"window_end\": \"2024-03-15\"\n }\n}", "name": "Success" } ] }, { "name": "Follow updates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/discovery\/follow-updates", "query": [ { "key": "limit", "value": "20", "description": "Max results (1-50).", "disabled": false }, { "key": "days", "value": "30", "description": "Lookback window in days (1-90).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Items per page (1-50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/discovery\/follow-updates?limit=20&days=30&page=1&per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"days\":1,\"page\":22,\"per_page\":7}" }, "description": "Returns recent releases from titles, series, characters, and creators the user follows.\nEach item includes a context string explaining why it's shown (e.g. \"New in X-Men\", \"Featuring Superman\")." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5432,\n \"issue_number\": \"26\",\n \"cover_url\": \"...\",\n \"release_date\": \"2026-03-04\",\n \"series\": {\"id\": 123, \"name\": \"X-Men\", \"start_year\": 2024},\n \"follow_context\": \"New in X-Men\",\n \"follow_type\": \"title\"\n }\n ],\n \"meta\": {\n \"days\": 30,\n \"total_follows\": 12\n }\n}", "name": "Success" } ] } ] }, { "name": "Titles", "description": "\nEndpoints for browsing comic book titles (franchises\/properties).\n\nA title represents a franchise (e.g., \"Batman\"), which may have multiple series under it.", "item": [ { "name": "List titles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/titles", "query": [ { "key": "q", "value": "spider-man", "description": "Search by title name.", "disabled": false }, { "key": "publisher", "value": "1", "description": "Filter by publisher ID.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/titles?q=spider-man&publisher=1&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name, slug, start_year, end_year, status, type, image_url,\nage_rating, is_nsfw, series_count, issues_count,\naverage_rating, total_reviews" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"name\": \"Batman\",\n \"slug\": \"batman\",\n \"start_year\": 1939,\n \"end_year\": null,\n \"status\": \"ongoing\",\n \"type\": \"Series\",\n \"image_url\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_md.webp\",\n \"images\": {\n \"cover_sm\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_sm.webp\",\n \"cover_md\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_md.webp\",\n \"cover_lg\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_lg.webp\"\n },\n \"average_rating\": 4.3,\n \"series_count\": 25,\n \"issues_count\": 1450,\n \"age_rating\": \"Teen\",\n \"is_nsfw\": false\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 50, \"per_page\": 20, \"total\": 1000}\n}", "name": "Success" } ] }, { "name": "Get a specific title", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/titles\/:title_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/titles\/:title_id", "variable": [ { "id": "title_id", "key": "title_id", "value": "147410", "description": "The ID of the title." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name, slug, description, start_year, end_year, status, type,\nimage_url, age_rating, is_nsfw, imprint_id, series_count,\nissues_count, average_rating, total_reviews, aliases\n\nUse relationship endpoints for richer data:\n- \/titles\/{id}\/series - Get series in a title\n- \/titles\/{id}\/issues - Get issues across all series in a title\n- \/titles\/{id}\/creators - Get creators credited on the title\n- \/titles\/{id}\/characters - Get characters associated with the title\n- \/titles\/{id}\/teams - Get teams associated with the title" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 12,\n \"name\": \"Batman\",\n \"slug\": \"batman\",\n \"description\": \"The continuing adventures of the Dark Knight across his many series.\",\n \"start_year\": 1939,\n \"end_year\": null,\n \"status\": \"ongoing\",\n \"type\": \"Series\",\n \"image_url\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_md.webp\",\n \"images\": {\n \"cover_sm\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_sm.webp\",\n \"cover_md\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_md.webp\",\n \"cover_lg\": \"https:\/\/r2.versedb.com\/uploads\/titles\/batman-12\/batman-12-abc123-cover_lg.webp\"\n },\n \"age_rating\": \"Teen\",\n \"is_nsfw\": false,\n \"imprint_id\": null,\n \"series_count\": 25,\n \"issues_count\": 1450,\n \"average_rating\": 4.3,\n \"aliases\": [\"The Dark Knight\", \"The Caped Crusader\"]\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Title].\"}", "name": "Not Found" } ] } ] }, { "name": "Series", "description": "\nEndpoints for browsing and searching comic book series.\n\nA series represents a specific volume or run of a title (e.g., \"Amazing Spider-Man (2018)\").", "item": [ { "name": "List series.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/series", "query": [ { "key": "q", "value": "spider-man", "description": "Search by series name.", "disabled": false }, { "key": "title_id", "value": "1", "description": "Filter by title ID.", "disabled": false }, { "key": "publisher_id", "value": "1", "description": "Filter by publisher ID.", "disabled": false }, { "key": "status", "value": "Ongoing", "description": "Filter by series status (Ongoing, Completed, Canceled).", "disabled": false }, { "key": "sort", "value": "start_year", "description": "Sort field (name, start_year, average_rating, latest_release_date, cached_issues_count).", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction (asc, desc).", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/series?q=spider-man&title_id=1&publisher_id=1&status=Ongoing&sort=start_year&direction=desc&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated series with optional search and filtering." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 123,\n \"title_id\": 45,\n \"name\": \"Amazing Spider-Man\",\n \"slug\": \"amazing-spider-man-2018\",\n \"number\": 6,\n \"start_year\": 2018,\n \"end_year\": 2022,\n \"cover_url\": \"https:\/\/...\",\n \"publication_type\": \"ongoing\",\n \"format\": \"comic\",\n \"status\": \"ended\",\n \"original_language\": \"en\",\n \"cached_issues_count\": 75,\n \"average_rating\": 4.2,\n \"total_reviews\": 150,\n \"age_rating\": \"teen\",\n \"is_nsfw\": false\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 5, \"per_page\": 20, \"total\": 100}\n}", "name": "Success" } ] }, { "name": "Get series details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/series\/:series_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/series\/:series_id", "variable": [ { "id": "series_id", "key": "series_id", "value": "123", "description": "The series ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single series with full details including related title, publishers, and genres.\nFor relationship data (issues, creators, characters), use the relationship endpoints." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 123,\n \"title_id\": 45,\n \"name\": \"Amazing Spider-Man\",\n \"slug\": \"amazing-spider-man-2018\",\n \"number\": 6,\n \"start_year\": 2018,\n \"end_year\": 2022,\n \"cover_url\": \"https:\/\/...\",\n \"description\": \"The sixth volume of Amazing Spider-Man...\",\n \"publication_type\": \"ongoing\",\n \"format\": \"comic\",\n \"status\": \"ended\",\n \"original_language\": \"en\",\n \"cached_issues_count\": 75,\n \"average_rating\": 4.2,\n \"total_reviews\": 150,\n \"age_rating\": \"teen\",\n \"is_nsfw\": false,\n \"cached_creators_count\": 12,\n \"cached_characters_count\": 24,\n \"cached_teams_count\": 3,\n \"lists_count\": 8,\n \"title\": {\"id\": 45, \"name\": \"Amazing Spider-Man\", \"url_slug\": \"amazing-spider-man\"},\n \"publisher\": {\"id\": 1, \"name\": \"Marvel\", \"slug\": \"marvel\"},\n \"publishers\": [{\"id\": 1, \"name\": \"Marvel\", \"slug\": \"marvel\"}],\n \"genres\": [{\"id\": 1, \"name\": \"Superhero\"}],\n \"imprint\": null,\n \"effective_imprint\": null,\n \"last_edited_by\": {\"id\": 42, \"name\": \"Jane Doe\", \"username\": \"janedoe\", \"avatar_url\": \"https:\/\/...\"},\n \"creators\": [{\"id\": 789, \"name\": \"Nick Spencer\", \"slug\": \"nick-spencer\", \"photo_url\": \"https:\/\/...\", \"role\": \"Writer\", \"is_uncredited\": false}],\n \"characters\": [{\"id\": 456, \"name\": \"Spider-Man (Peter Parker)\", \"slug\": \"spider-man-peter-parker\", \"real_name\": \"Peter Parker\", \"aliases\": [], \"image_url\": \"https:\/\/...\", \"appearances_count\": 75}],\n \"teams\": [{\"id\": 33, \"name\": \"Avengers\", \"slug\": \"avengers\", \"image_url\": \"https:\/\/...\", \"members_count\": 24}],\n \"foc_issues\": [{\"id\": 9912, \"issue_number\": \"42\", \"name\": \"Issue 42\", \"release_date\": \"2026-06-04\", \"foc_date\": \"2026-05-12\", \"cover_url\": \"https:\/\/...\"}],\n \"upcoming_issues\": [{\"id\": 9913, \"issue_number\": \"43\", \"name\": \"Issue 43\", \"release_date\": \"2026-06-11\", \"cover_url\": \"https:\/\/...\"}]\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Not Found\"\n}", "name": "Not Found" } ] }, { "name": "Get series issues.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/series\/:id\/issues", "query": [ { "key": "sort", "value": "issue_number", "description": "Sort field (issue_number, release_date, name).", "disabled": false }, { "key": "direction", "value": "asc", "description": "Sort direction (asc, desc).", "disabled": false }, { "key": "limit", "value": "20", "description": "Results per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/series\/:id\/issues?sort=issue_number&direction=asc&limit=20", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The series ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated issues for a specific series." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5432,\n \"number\": \"1\",\n \"name\": \"The Amazing Spider-Man #1\",\n \"release_date\": \"2018-07-11\",\n \"cover_url\": \"https:\/\/...\",\n \"average_rating\": 4.5\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 4, \"per_page\": 20, \"total\": 75}\n}", "name": "Success" } ] }, { "name": "Get series creators.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/series\/:id\/creators", "query": [], "raw": "{{baseUrl}}\/api\/v1\/series\/:id\/creators", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The series ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated creators associated with a specific series." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 789,\n \"name\": \"Nick Spencer\",\n \"role\": {\"id\": 1, \"name\": \"Writer\"}\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 50, \"total\": 15}\n}", "name": "Success" } ] }, { "name": "Get series characters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/series\/:id\/characters", "query": [], "raw": "{{baseUrl}}\/api\/v1\/series\/:id\/characters", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The series ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated characters appearing in a specific series." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 456,\n \"name\": \"Spider-Man (Peter Parker)\",\n \"alias\": \"Peter Parker\",\n \"image_url\": \"https:\/\/...\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 2, \"per_page\": 50, \"total\": 75}\n}", "name": "Success" } ] } ] }, { "name": "Issues", "description": "\nEndpoints for browsing and searching comic book issues.\n\nAn issue is a single publication in a series (e.g., \"Amazing Spider-Man #1\").", "item": [ { "name": "List issues.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues", "query": [ { "key": "q", "value": "origin", "description": "Search by issue name.", "disabled": false }, { "key": "series_id", "value": "123", "description": "Filter by series ID.", "disabled": false }, { "key": "publisher_id", "value": "1", "description": "Filter by publisher ID (via series relationship).", "disabled": false }, { "key": "release_date_from", "value": "2024-01-01", "description": "Filter by release date (from).", "disabled": false }, { "key": "release_date_to", "value": "2024-12-31", "description": "Filter by release date (to).", "disabled": false }, { "key": "include", "value": "series", "description": "Comma-separated relationships to include (series).", "disabled": false }, { "key": "sort", "value": "release_date", "description": "Sort field (issue_number, release_date, name).", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction (asc, desc).", "disabled": false }, { "key": "limit", "value": "20", "description": "Results per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/issues?q=origin&series_id=123&publisher_id=1&release_date_from=2024-01-01&release_date_to=2024-12-31&include=series&sort=release_date&direction=desc&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated issues with optional search, filtering, and sorting." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5432,\n \"slug\": \"amazing-spider-man-1\",\n \"series_id\": 123,\n \"issue_number\": \"1\",\n \"name\": \"The Amazing Spider-Man #1\",\n \"release_date\": \"2018-07-11\",\n \"cover_url\": \"https:\/\/...\",\n \"is_reprint\": false,\n \"age_rating\": \"teen\",\n \"is_nsfw\": false\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 10, \"per_page\": 20, \"total\": 200}\n}", "name": "Success" } ] }, { "name": "Get issue details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single issue with full details including series, title, publishers,\ncreators, characters, teams, and story arcs." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 5432,\n \"slug\": \"amazing-spider-man-1\",\n \"series_id\": 123,\n \"issue_number\": \"1\",\n \"name\": \"The Amazing Spider-Man #1\",\n \"description\": \"Nick Spencer and Ryan Ottley begin a new era...\",\n \"release_date\": \"2018-07-11\",\n \"cover_date\": \"2018-09-01\",\n \"cover_url\": \"https:\/\/...\",\n \"is_reprint\": false,\n \"age_rating\": \"teen\",\n \"is_nsfw\": false,\n \"page_count\": 40,\n \"price\": \"4.99\",\n \"upc\": \"75960608936700111\",\n \"series\": {\"id\": 123, \"name\": \"Amazing Spider-Man\", \"slug\": \"amazing-spider-man-2018\"},\n \"title\": {\"id\": 45, \"name\": \"Amazing Spider-Man\"},\n \"publisher\": {\"id\": 1, \"name\": \"Marvel\", \"slug\": \"marvel\"},\n \"creators\": [{\"id\": 789, \"name\": \"Nick Spencer\", \"slug\": \"nick-spencer\", \"role\": \"Writer\"}],\n \"characters\": [{\"id\": 456, \"name\": \"Spider-Man\", \"slug\": \"spider-man\"}]\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Not Found\"\n}", "name": "Not Found" } ] }, { "name": "Get issue variants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/variants", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/variants", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all variant covers for a specific issue." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 9001,\n \"variant_name\": \"J. Scott Campbell Variant\",\n \"variant_type\": \"incentive\",\n \"ratio\": \"1:25\",\n \"cover_url\": \"https:\/\/...\",\n \"creators\": [{\"id\": 101, \"name\": \"J. Scott Campbell\", \"role\": \"Cover Artist\"}]\n }\n ]\n}", "name": "Success" } ] }, { "name": "Get variant details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/variants\/:variant_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/variants\/:variant_id", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." }, { "id": "variant_id", "key": "variant_id", "value": "9001", "description": "The variant ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a specific variant cover with full details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 9001,\n \"issue_id\": 5432,\n \"variant_name\": \"J. Scott Campbell Variant\",\n \"variant_type\": \"incentive\",\n \"ratio\": \"1:25\",\n \"cover_url\": \"https:\/\/...\",\n \"price\": \"49.99\",\n \"ean\": \"75960608936700121\",\n \"creators\": [{\"id\": 101, \"name\": \"J. Scott Campbell\", \"slug\": \"j-scott-campbell\", \"role\": \"Cover Artist\"}]\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Variant does not belong to this issue\"\n}", "name": "Not Found" } ] }, { "name": "Get issue creators.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:id\/creators", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:id\/creators", "variable": [ { "id": "id", "key": "id", "value": "5432", "description": "The issue ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated creators for a specific issue with their roles." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 789,\n \"name\": \"Nick Spencer\",\n \"role\": {\"id\": 1, \"name\": \"Writer\"}\n },\n {\n \"id\": 790,\n \"name\": \"Ryan Ottley\",\n \"role\": {\"id\": 2, \"name\": \"Artist\"}\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 50, \"total\": 8}\n}", "name": "Success" } ] }, { "name": "Get issue characters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:id\/characters", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:id\/characters", "variable": [ { "id": "id", "key": "id", "value": "5432", "description": "The issue ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated characters appearing in a specific issue." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 456,\n \"name\": \"Spider-Man (Peter Parker)\",\n \"alias\": \"Peter Parker\",\n \"image_url\": \"https:\/\/...\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 50, \"total\": 15}\n}", "name": "Success" } ] }, { "name": "Get key issue reasons.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/key-reasons", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/key-reasons", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns key issue reasons for a specific issue (e.g., \"1st Appearance\", \"Death\")." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"1st Appearance\",\n \"category\": \"appearance\",\n \"description\": \"First appearance of a character\",\n \"notes\": \"1st full appearance of Wolverine (Logan)\",\n \"source\": \"manual\"\n }\n ]\n}", "name": "Success" } ] } ] }, { "name": "Publishers", "description": "\nEndpoints for browsing comic book publishers.", "item": [ { "name": "List all publishers with optional search", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/publishers", "query": [ { "key": "q", "value": "marvel", "description": "Search by publisher name.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/publishers?q=marvel&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name, founded_year, headquarters, status, logo_url" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Marvel Comics\",\n \"founded_year\": 1939,\n \"headquarters\": \"New York, NY\",\n \"status\": \"active\",\n \"series_count\": 12500,\n \"logo_url\": \"https:\/\/...-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/...-tile_sm.webp\",\n \"profile_md\": \"https:\/\/...-profile_md.webp\",\n \"full_lg\": \"https:\/\/...-full_lg.webp\"\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 25, \"per_page\": 20, \"total\": 500}\n}", "name": "Success" } ] }, { "name": "Get publisher details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/publishers\/:publisher_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/publishers\/:publisher_id", "variable": [ { "id": "publisher_id", "key": "publisher_id", "value": "59241", "description": "The ID of the publisher." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name, description, founded_year, first_published_year,\nwebsite, headquarters, parent_company, status, logo_url, aliases\n\nUse the related endpoints for relationship data:\n- \/series?publisher_id={id} - Get series by publisher\n- \/publishers\/{id}\/characters - Get characters by publisher" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"Marvel Comics\",\n \"description\": \"American comic book publisher, home to Spider-Man, the X-Men, and the Avengers.\",\n \"founded_year\": 1939,\n \"website\": \"https:\/\/www.marvel.com\",\n \"headquarters\": \"New York, NY\",\n \"parent_company\": \"The Walt Disney Company\",\n \"status\": \"active\",\n \"logo_url\": \"https:\/\/r2.versedb.com\/uploads\/publishers\/marvel-1\/marvel-1-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/r2.versedb.com\/uploads\/publishers\/marvel-1\/marvel-1-tile_sm.webp\",\n \"profile_md\": \"https:\/\/r2.versedb.com\/uploads\/publishers\/marvel-1\/marvel-1-profile_md.webp\",\n \"full_lg\": \"https:\/\/r2.versedb.com\/uploads\/publishers\/marvel-1\/marvel-1-full_lg.webp\"\n },\n \"first_published_year\": 1939,\n \"aliases\": [\"Marvel\", \"Timely Comics\", \"Atlas Comics\"]\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Publisher].\"}", "name": "Not Found" } ] } ] }, { "name": "Imprints", "description": "\nEndpoints for browsing comic book imprints (publisher sub-brands, e.g.,\nVertigo under DC, Icon under Marvel).", "item": [ { "name": "List imprints", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/imprints", "query": [ { "key": "q", "value": "vertigo", "description": "Search by imprint name.", "disabled": false }, { "key": "publisher_id", "value": "2", "description": "Filter by publisher ID.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/imprints?q=vertigo&publisher_id=2&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name, slug, description, publisher" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 7,\n \"name\": \"Vertigo\",\n \"slug\": \"vertigo\",\n \"description\": \"DC's mature readers imprint, home to Sandman, Preacher, and Y: The Last Man.\",\n \"publisher\": {\"id\": 2, \"name\": \"DC Comics\", \"slug\": \"dc-comics\"}\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 3, \"per_page\": 20, \"total\": 45}\n}", "name": "Success" } ] }, { "name": "Get imprint details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/imprints\/:imprint_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/imprints\/:imprint_id", "variable": [ { "id": "imprint_id", "key": "imprint_id", "value": "6", "description": "The ID of the imprint." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name, slug, description, publisher, series_count, titles_count" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 7,\n \"name\": \"Vertigo\",\n \"slug\": \"vertigo\",\n \"description\": \"DC's mature readers imprint, home to Sandman, Preacher, and Y: The Last Man.\",\n \"publisher\": {\"id\": 2, \"name\": \"DC Comics\", \"slug\": \"dc-comics\"},\n \"series_count\": 312,\n \"titles_count\": 145,\n \"created_at\": \"2024-01-15T12:00:00.000000Z\",\n \"updated_at\": \"2024-06-01T08:30:00.000000Z\"\n }\n}", "name": "Success" } ] } ] }, { "name": "Creators", "description": "\nEndpoints for browsing and searching comic book creators.\n\nCreators include writers, artists, colorists, letterers, editors, and other roles.", "item": [ { "name": "List creators.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/creators", "query": [ { "key": "q", "value": "alan+moore", "description": "Search by creator name.", "disabled": false }, { "key": "limit", "value": "20", "description": "Results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/creators?q=alan+moore&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated creators with optional search and sorting." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 789,\n \"name\": \"Alan Moore\",\n \"slug\": \"alan-moore\",\n \"role\": {\"id\": 1, \"name\": \"Writer\"},\n \"photo_url\": \"https:\/\/...-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/...-tile_sm.webp\",\n \"profile_md\": \"https:\/\/...-profile_md.webp\",\n \"full_lg\": \"https:\/\/...-full_lg.webp\"\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 100, \"per_page\": 20, \"total\": 2000}\n}", "name": "Success" } ] }, { "name": "Get creator details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/creators\/:creator_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/creators\/:creator_id", "variable": [ { "id": "creator_id", "key": "creator_id", "value": "789", "description": "The creator ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single creator with full details including biography, role, and awards." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 789,\n \"name\": \"Alan Moore\",\n \"slug\": \"alan-moore\",\n \"role\": {\"id\": 1, \"name\": \"Writer\"},\n \"photo_url\": \"https:\/\/...-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/...-tile_sm.webp\",\n \"profile_md\": \"https:\/\/...-profile_md.webp\",\n \"full_lg\": \"https:\/\/...-full_lg.webp\"\n },\n \"biography\": \"Alan Moore is a British comic book writer...\",\n \"gender\": \"male\",\n \"birth\": \"1953-11-18\",\n \"death\": null,\n \"birth_place\": \"Northampton, England\",\n \"country\": \"United Kingdom\",\n \"aliases\": [],\n \"links\": {\"website\": \"...\", \"twitter\": \"...\"},\n \"awards\": [{\"name\": \"Eisner Award\", \"year\": 1988}]\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Not Found\"\n}", "name": "Not Found" } ] }, { "name": "Get creator's blog posts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/creators\/:creator_id\/blog-posts", "query": [ { "key": "limit", "value": "10", "description": "Results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/creators\/:creator_id\/blog-posts?limit=10", "variable": [ { "id": "creator_id", "key": "creator_id", "value": "789", "description": "The creator ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated published blog posts where this creator is featured." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"slug\": \"spotlight-alan-moore\",\n \"title\": \"Creator Spotlight: Alan Moore\",\n \"featured_image_url\": \"https:\/\/...\",\n \"category\": {\"id\": 2, \"name\": \"Spotlights\", \"slug\": \"spotlights\"},\n \"author\": {\"id\": 1, \"name\": \"VerseDB Editorial\"},\n \"published_at\": \"2026-04-15T12:00:00+00:00\",\n \"reading_time\": 6\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 10, \"total\": 3}\n}", "name": "Success" } ] }, { "name": "Get creator's issues.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/creators\/:creator_id\/issues", "query": [ { "key": "limit", "value": "20", "description": "Results per page (max 50).", "disabled": false }, { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/creators\/:creator_id\/issues?limit=20&q=batman", "variable": [ { "id": "creator_id", "key": "creator_id", "value": "789", "description": "The creator ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated issues where the creator has a credit." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 123,\n \"slug\": \"batman-1\",\n \"series_id\": 456,\n \"issue_number\": \"1\",\n \"name\": \"Batman #1\",\n \"release_date\": \"2023-01-15\",\n \"cover_url\": \"https:\/\/...\",\n \"series\": {\"id\": 456, \"name\": \"Batman\", \"slug\": \"batman\"}\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 10, \"per_page\": 20, \"total\": 200}\n}", "name": "Success" } ] }, { "name": "Get creator's series.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/creators\/:creator_id\/series", "query": [ { "key": "limit", "value": "20", "description": "Results per page (max 50).", "disabled": false }, { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/creators\/:creator_id\/series?limit=20&q=batman", "variable": [ { "id": "creator_id", "key": "creator_id", "value": "789", "description": "The creator ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated series where the creator has worked." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 456,\n \"name\": \"Batman\",\n \"slug\": \"batman\",\n \"start_year\": 2016,\n \"end_year\": 2020,\n \"cover_url\": \"https:\/\/...\",\n \"cached_issues_count\": 85\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 5, \"per_page\": 20, \"total\": 100}\n}", "name": "Success" } ] } ] }, { "name": "Characters", "description": "\nEndpoints for browsing and searching comic book characters.\n\nCharacters include heroes, villains, and supporting characters across all publishers.", "item": [ { "name": "List characters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/characters", "query": [ { "key": "q", "value": "spider-man", "description": "Search by character name.", "disabled": false }, { "key": "limit", "value": "20", "description": "Results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/characters?q=spider-man&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated characters with optional search and sorting." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 456,\n \"name\": \"Spider-Man (Peter Parker)\",\n \"slug\": \"spider-man-peter-parker\",\n \"real_name\": \"Peter Parker\",\n \"aliases\": [\"Spidey\", \"Web-Head\"],\n \"image_url\": \"https:\/\/...-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/...-tile_sm.webp\",\n \"profile_md\": \"https:\/\/...-profile_md.webp\",\n \"full_lg\": \"https:\/\/...-full_lg.webp\"\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 50, \"per_page\": 20, \"total\": 1000}\n}", "name": "Success" } ] }, { "name": "Get character details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/characters\/:character_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/characters\/:character_id", "variable": [ { "id": "character_id", "key": "character_id", "value": "456", "description": "The character ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single character with full details including publishers and\ncached relationship counts (appearances, series, teams, story arcs) so\nclients can decide which related-entity tabs to expose." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 456,\n \"name\": \"Spider-Man (Peter Parker)\",\n \"slug\": \"spider-man-peter-parker\",\n \"real_name\": \"Peter Parker\",\n \"aliases\": [\"Spidey\", \"Web-Head\", \"Webslinger\"],\n \"image_url\": \"https:\/\/...-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/...-tile_sm.webp\",\n \"profile_md\": \"https:\/\/...-profile_md.webp\",\n \"full_lg\": \"https:\/\/...-full_lg.webp\"\n },\n \"description\": \"Peter Parker was bitten by a radioactive spider...\",\n \"alter_ego\": [],\n \"gender\": \"male\",\n \"race\": \"Human\",\n \"birth_place\": \"Queens, New York\",\n \"occupation\": \"Photographer, Scientist\",\n \"appearances_count\": 12500,\n \"series_count\": 320,\n \"teams_count\": 8,\n \"story_arcs_count\": 47,\n \"powers\": [\"Super strength\", \"Wall-crawling\", \"Spider-sense\"],\n \"publisher\": {\"id\": 1, \"name\": \"Marvel\", \"slug\": \"marvel\"}\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Not Found\"\n}", "name": "Not Found" } ] }, { "name": "Get character series.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/characters\/:character_id\/series", "query": [ { "key": "limit", "value": "20", "description": "Results per page (max 50).", "disabled": false }, { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/characters\/:character_id\/series?limit=20&q=batman", "variable": [ { "id": "character_id", "key": "character_id", "value": "456", "description": "The character ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated series where the character appears." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Amazing Spider-Man\",\n \"slug\": \"amazing-spider-man-2018\",\n \"start_year\": 2018,\n \"end_year\": 2022,\n \"image_url\": \"https:\/\/...\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 5, \"per_page\": 20, \"total\": 100}\n}", "name": "Success" } ] }, { "name": "Get character issues.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/characters\/:character_id\/issues", "query": [ { "key": "limit", "value": "20", "description": "Results per page (max 50).", "disabled": false }, { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/characters\/:character_id\/issues?limit=20&q=batman", "variable": [ { "id": "character_id", "key": "character_id", "value": "456", "description": "The character ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated issues where the character appears, ordered by release date." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5432,\n \"number\": \"1\",\n \"name\": \"The Amazing Spider-Man #1\",\n \"release_date\": \"2018-07-11\",\n \"cover_url\": \"https:\/\/...\",\n \"series\": {\"id\": 123, \"name\": \"Amazing Spider-Man\"}\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 100, \"per_page\": 20, \"total\": 2000}\n}", "name": "Success" } ] }, { "name": "Get character teams.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/characters\/:character_id\/teams", "query": [ { "key": "limit", "value": "20", "description": "Results per page (max 50).", "disabled": false }, { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/characters\/:character_id\/teams?limit=20&q=batman", "variable": [ { "id": "character_id", "key": "character_id", "value": "456", "description": "The character ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated teams the character is a member of, including membership details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 10,\n \"name\": \"Avengers\",\n \"slug\": \"avengers\",\n \"image_url\": \"https:\/\/...\",\n \"membership\": {\n \"role\": \"Member\",\n \"joined_date\": \"2012-05-01\",\n \"left_date\": null\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 20, \"total\": 5}\n}", "name": "Success" } ] } ] }, { "name": "Teams", "description": "\nEndpoints for browsing superhero teams and their members.", "item": [ { "name": "List all teams with optional search", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams", "query": [ { "key": "q", "value": "avengers", "description": "Search by team name.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/teams?q=avengers&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"name\": \"Avengers\",\n \"slug\": \"avengers\",\n \"aliases\": [\"Earth's Mightiest Heroes\"],\n \"headquarters\": \"Avengers Tower, New York City\",\n \"members_count\": 42,\n \"appearances_count\": 1250,\n \"image_url\": \"https:\/\/images.versedb.com\/teams\/avengers\/tile_sm.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/images.versedb.com\/teams\/avengers\/tile_sm.webp\",\n \"profile_md\": \"https:\/\/images.versedb.com\/teams\/avengers\/profile_md.webp\",\n \"full_lg\": \"https:\/\/images.versedb.com\/teams\/avengers\/full_lg.webp\"\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 8, \"per_page\": 20, \"total\": 156}\n}", "name": "Success" } ] }, { "name": "Get a specific team", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id", "variable": [ { "id": "team_id", "key": "team_id", "value": "20281", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns team details without relationship data.\nUse the relationship endpoints for related data:\n- \/teams\/{id}\/characters - Get team members\n- \/teams\/{id}\/series - Get team's series appearances\n- \/teams\/{id}\/issues - Get team's issue appearances" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 78,\n \"name\": \"Avengers\",\n \"slug\": \"avengers\",\n \"aliases\": [\"Earth's Mightiest Heroes\"],\n \"description\": \"A team of superheroes formed to confront threats no single hero could withstand.\",\n \"formation_date\": \"1963-09-01\",\n \"disbanded_date\": null,\n \"headquarters\": \"Avengers Tower, New York\",\n \"members_count\": 312,\n \"series_count\": 48,\n \"appearances_count\": 5200,\n \"lists_count\": 86,\n \"image_url\": \"https:\/\/r2.versedb.com\/uploads\/teams\/avengers-78\/avengers-78-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/r2.versedb.com\/uploads\/teams\/avengers-78\/avengers-78-tile_sm.webp\",\n \"profile_md\": \"https:\/\/r2.versedb.com\/uploads\/teams\/avengers-78\/avengers-78-profile_md.webp\",\n \"full_lg\": \"https:\/\/r2.versedb.com\/uploads\/teams\/avengers-78\/avengers-78-full_lg.webp\"\n }\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Team].\"}", "name": "Not Found" } ] }, { "name": "Get characters for a specific team (members)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/characters", "query": [ { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/characters?q=batman", "variable": [ { "id": "team_id", "key": "team_id", "value": "20281", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 456,\n \"name\": \"Captain America\",\n \"slug\": \"captain-america\",\n \"real_name\": \"Steve Rogers\",\n \"aliases\": [\"Cap\", \"Sentinel of Liberty\"],\n \"race\": \"Human\",\n \"image_url\": \"https:\/\/images.versedb.com\/characters\/captain-america\/full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/images.versedb.com\/characters\/captain-america\/tile_sm.webp\",\n \"profile_md\": \"https:\/\/images.versedb.com\/characters\/captain-america\/profile_md.webp\",\n \"full_lg\": \"https:\/\/images.versedb.com\/characters\/captain-america\/full_lg.webp\"\n },\n \"appearances_count\": 980,\n \"publisher_name\": \"Marvel Comics\",\n \"pivot_role\": \"Leader\",\n \"pivot_joined_date\": \"1963-09-01\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 2, \"per_page\": 50, \"total\": 67}\n}", "name": "Success" } ] }, { "name": "Get series for a specific team", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/series", "query": [ { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/series?q=batman", "variable": [ { "id": "team_id", "key": "team_id", "value": "20281", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 123,\n \"title_id\": 45,\n \"name\": \"Avengers\",\n \"slug\": \"avengers-2018\",\n \"start_year\": 2018,\n \"end_year\": 2023,\n \"medium\": \"comic\",\n \"publication_type\": \"regular_series\",\n \"status\": \"ended\",\n \"average_rating\": 4.1,\n \"total_reviews\": 150,\n \"is_nsfw\": false\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 50, \"total\": 12}\n}", "name": "Success" } ] }, { "name": "Get issues for a specific team", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/issues", "query": [ { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/issues?q=batman", "variable": [ { "id": "team_id", "key": "team_id", "value": "20281", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5432,\n \"series_id\": 123,\n \"issue_number\": \"1\",\n \"name\": \"The Final Host\",\n \"release_date\": \"2018-05-02\",\n \"cover_date\": \"2018-07-01\",\n \"average_rating\": 4.3,\n \"is_nsfw\": false\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 25, \"per_page\": 50, \"total\": 1250}\n}", "name": "Success" } ] } ] }, { "name": "Story Arcs", "description": "\nEndpoints for browsing story arcs and crossover events.", "item": [ { "name": "List all story arcs with optional search", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/story-arcs", "query": [ { "key": "q", "value": "civil+war", "description": "Search by story arc name.", "disabled": false }, { "key": "status", "value": "ended", "description": "Filter by status.", "disabled": false }, { "key": "type", "value": "crossover_event", "description": "Filter by type.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/story-arcs?q=civil+war&status=ended&type=crossover_event&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 16,\n \"name\": \"Civil War\",\n \"slug\": \"civil-war\",\n \"type\": \"crossover_event\",\n \"status\": \"ended\",\n \"image_url\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-md.jpg\",\n \"images\": {\n \"cover_sm\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-sm.jpg\",\n \"cover_md\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-md.jpg\",\n \"cover_lg\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-lg.jpg\"\n },\n \"issues_count\": 102,\n \"primary_universe\": {\"id\": 1, \"name\": \"Earth-616\"}\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 12, \"per_page\": 20, \"total\": 230}\n}", "name": "Success" } ] }, { "name": "Get story arc detail.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/story-arcs\/:storyArc_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/story-arcs\/:storyArc_id", "variable": [ { "id": "storyArc_id", "key": "storyArc_id", "value": "16", "description": "The story arc ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns full story arc detail with the primary and secondary universes,\na denormalized characters count, the start\/end issue summaries (each\nwith its parent series), and the last user who edited the arc.\n\nPaginated relationship data lives on dedicated nested endpoints:\n- GET \/story-arcs\/{id}\/issues - Issues in the arc, in reading order\n- GET \/story-arcs\/{id}\/series - Series spanned by the arc\n- GET \/story-arcs\/{id}\/characters - Characters appearing in the arc" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 16,\n \"name\": \"Civil War\",\n \"slug\": \"civil-war\",\n \"description\": \"A superhero registration act divides the Marvel Universe...\",\n \"type\": \"crossover_event\",\n \"status\": \"ended\",\n \"image_url\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-md.jpg\",\n \"images\": {\n \"cover_sm\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-sm.jpg\",\n \"cover_md\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-md.jpg\",\n \"cover_lg\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-lg.jpg\"\n },\n \"primary_universe_id\": 1,\n \"issues_count\": 102,\n \"characters_count\": 87,\n \"primary_universe\": {\n \"id\": 1,\n \"name\": \"Earth-616\",\n \"description\": \"The primary continuity of the Marvel Universe.\"\n },\n \"universes\": [\n {\"id\": 12, \"name\": \"Ultimate Universe\"}\n ],\n \"start_issue\": {\n \"id\": 5432,\n \"name\": \"Civil War #1\",\n \"slug\": \"civil-war-1\",\n \"issue_number\": \"1\",\n \"series_id\": 412,\n \"cover_url\": \"https:\/\/cdn.versedb.com\/issues\/civil-war-1-md.jpg\",\n \"images\": {\"cover_md\": \"https:\/\/cdn.versedb.com\/issues\/civil-war-1-md.jpg\"},\n \"series\": {\"id\": 412, \"name\": \"Civil War\", \"slug\": \"civil-war-2006\", \"start_year\": 2006}\n },\n \"end_issue\": {\n \"id\": 5439,\n \"name\": \"Civil War #7\",\n \"slug\": \"civil-war-7\",\n \"issue_number\": \"7\",\n \"series_id\": 412,\n \"cover_url\": \"https:\/\/cdn.versedb.com\/issues\/civil-war-7-md.jpg\",\n \"images\": {\"cover_md\": \"https:\/\/cdn.versedb.com\/issues\/civil-war-7-md.jpg\"},\n \"series\": {\"id\": 412, \"name\": \"Civil War\", \"slug\": \"civil-war-2006\", \"start_year\": 2006}\n },\n \"last_edited_by\": {\n \"id\": 42,\n \"name\": \"Jane Doe\",\n \"username\": \"janedoe\",\n \"avatar_url\": \"https:\/\/cdn.versedb.com\/users\/janedoe-md.jpg\"\n }\n }\n}", "name": "Success" } ] }, { "name": "Get story arcs for a specific issue", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/story-arcs", "query": [ { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/story-arcs?q=batman", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "1087905", "description": "The ID of the issue." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 24,\n \"name\": \"The Night Gwen Stacy Died\",\n \"slug\": \"the-night-gwen-stacy-died\",\n \"type\": \"main_story\",\n \"status\": \"ended\",\n \"image_url\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-md.jpg\",\n \"images\": {\n \"cover_sm\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-sm.jpg\",\n \"cover_md\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-md.jpg\",\n \"cover_lg\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-lg.jpg\"\n },\n \"issues_count\": 2\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 15, \"total\": 1}\n}", "name": "Success" } ] }, { "name": "Get story arcs for a specific character", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/characters\/:character_id\/story-arcs", "query": [ { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/characters\/:character_id\/story-arcs?q=batman", "variable": [ { "id": "character_id", "key": "character_id", "value": "54014", "description": "The ID of the character." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 16,\n \"name\": \"Civil War\",\n \"slug\": \"civil-war\",\n \"type\": \"crossover_event\",\n \"status\": \"ended\",\n \"image_url\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-md.jpg\",\n \"images\": {\n \"cover_sm\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-sm.jpg\",\n \"cover_md\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-md.jpg\",\n \"cover_lg\": \"https:\/\/cdn.versedb.com\/story_arcs\/civil-war-lg.jpg\"\n },\n \"issues_count\": 102\n },\n {\n \"id\": 24,\n \"name\": \"The Night Gwen Stacy Died\",\n \"slug\": \"the-night-gwen-stacy-died\",\n \"type\": \"main_story\",\n \"status\": \"ended\",\n \"image_url\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-md.jpg\",\n \"images\": {\n \"cover_sm\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-sm.jpg\",\n \"cover_md\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-md.jpg\",\n \"cover_lg\": \"https:\/\/cdn.versedb.com\/story_arcs\/the-night-gwen-stacy-died-lg.jpg\"\n },\n \"issues_count\": 2\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 3, \"per_page\": 15, \"total\": 41}\n}", "name": "Success" } ] }, { "name": "Get story arcs for a specific universe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/universes\/:universe_id\/story-arcs", "query": [ { "key": "q", "value": "batman", "description": "Optional case-insensitive search within these results.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/universes\/:universe_id\/story-arcs?q=batman", "variable": [ { "id": "universe_id", "key": "universe_id", "value": "16", "description": "The ID of the universe." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 88,\n \"name\": \"Crisis on Infinite Earths\",\n \"slug\": \"crisis-on-infinite-earths\",\n \"type\": \"crossover_event\",\n \"status\": \"ended\",\n \"image_url\": \"https:\/\/cdn.versedb.com\/story_arcs\/crisis-on-infinite-earths-md.jpg\",\n \"images\": {\n \"cover_sm\": \"https:\/\/cdn.versedb.com\/story_arcs\/crisis-on-infinite-earths-sm.jpg\",\n \"cover_md\": \"https:\/\/cdn.versedb.com\/story_arcs\/crisis-on-infinite-earths-md.jpg\",\n \"cover_lg\": \"https:\/\/cdn.versedb.com\/story_arcs\/crisis-on-infinite-earths-lg.jpg\"\n },\n \"issues_count\": 12\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 4, \"per_page\": 15, \"total\": 56}\n}", "name": "Success" } ] } ] }, { "name": "Universes", "description": "\nEndpoints for browsing comic book universes (e.g., Marvel Universe, DC New 52).", "item": [ { "name": "List universes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/universes", "query": [ { "key": "q", "value": "marvel", "description": "Search by universe name.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/universes?q=marvel&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Marvel Universe (616)\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 3, \"per_page\": 20, \"total\": 42}\n}", "name": "Success" } ] }, { "name": "Get a specific universe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/universes\/:universe_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/universes\/:universe_id", "variable": [ { "id": "universe_id", "key": "universe_id", "value": "16", "description": "The ID of the universe." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, name, description\n\nUse the relationship endpoints for related data:\n- \/universes\/{id}\/story-arcs - Get story arcs in a universe\n- \/universes\/{id}\/characters - Get characters in a universe" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"Marvel Universe (616)\",\n \"description\": \"The primary continuity of Marvel Comics, home to most mainline Marvel stories since 1961.\"\n }\n}", "name": "Success" } ] } ] }, { "name": "Events", "description": "\nEndpoints for browsing comic conventions and store events.", "item": [ { "name": "List events.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events", "query": [ { "key": "q", "value": "comic-con", "description": "Search by event name.", "disabled": false }, { "key": "type", "value": "convention", "description": "Filter by type (convention, store_event, signing, etc).", "disabled": false }, { "key": "upcoming", "value": "1", "description": "Only show upcoming events.", "disabled": false }, { "key": "past", "value": "1", "description": "Only show past events.", "disabled": false }, { "key": "is_online", "value": "", "description": "Filter online\/in-person events.", "disabled": true }, { "key": "is_fcbd", "value": "1", "description": "Filter Free Comic Book Day events.", "disabled": false }, { "key": "country_code", "value": "US", "description": "Filter by country code.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/events?q=comic-con&type=convention&upcoming=1&past=1&is_online=&is_fcbd=1&country_code=US&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns: id, slug, name, type, dates, location info, logo_url" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 42,\n \"slug\": \"san-diego-comic-con-2026\",\n \"name\": \"San Diego Comic-Con 2026\",\n \"type\": \"convention\",\n \"start_date\": \"2026-07-23\",\n \"end_date\": \"2026-07-26\",\n \"is_online\": false,\n \"is_fcbd\": false,\n \"venue_name\": \"San Diego Convention Center\",\n \"city\": \"San Diego\",\n \"region\": \"CA\",\n \"country_code\": \"US\",\n \"full_location\": \"San Diego Convention Center, San Diego, CA, United States\",\n \"logo_url\": \"https:\/\/...-tile_sm.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/...-tile_sm.webp\",\n \"full_md\": \"https:\/\/...-full_md.webp\",\n \"full_lg\": \"https:\/\/...-full_lg.webp\"\n },\n \"ticket_price\": \"$45.00 - $150.00\",\n \"follower_count\": 320\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 8, \"per_page\": 20, \"total\": 156}\n}", "name": "Success" } ] }, { "name": "Get an event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events\/:event_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/events\/:event_id", "variable": [ { "id": "event_id", "key": "event_id", "value": "406", "description": "The ID of the event." }, { "id": "event", "key": "event", "value": "42", "description": "The event ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns full event details including links and map data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 42,\n \"slug\": \"san-diego-comic-con-2026\",\n \"name\": \"San Diego Comic-Con 2026\",\n \"type\": \"convention\",\n \"start_date\": \"2026-07-23\",\n \"end_date\": \"2026-07-26\",\n \"timezone\": \"America\/Los_Angeles\",\n \"is_online\": false,\n \"is_fcbd\": false,\n \"venue_name\": \"San Diego Convention Center\",\n \"street_address\": \"111 W Harbor Dr\",\n \"city\": \"San Diego\",\n \"region\": \"CA\",\n \"postal_code\": \"92101\",\n \"country_code\": \"US\",\n \"latitude\": 32.7065,\n \"longitude\": -117.1615,\n \"full_location\": \"San Diego Convention Center, San Diego, CA, United States\",\n \"google_maps_url\": \"https:\/\/maps.google.com\/?q=32.7065,-117.1615\",\n \"logo_url\": \"https:\/\/cdn.versedb.com\/events\/42-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/cdn.versedb.com\/events\/42-tile_sm.webp\",\n \"full_md\": \"https:\/\/cdn.versedb.com\/events\/42-full_md.webp\",\n \"full_lg\": \"https:\/\/cdn.versedb.com\/events\/42-full_lg.webp\"\n },\n \"static_map_url\": \"https:\/\/cdn.versedb.com\/events\/42-static-map.png\",\n \"event_url\": \"https:\/\/www.comic-con.org\",\n \"ticket_price_min\": \"45.00\",\n \"ticket_price_max\": \"150.00\",\n \"ticket_currency\": \"USD\",\n \"ticket_price\": \"$45.00 - $150.00\",\n \"follower_count\": 320,\n \"creators\": [\n {\"id\": 7, \"name\": \"Stan Lee\", \"slug\": \"stan-lee\", \"photo_url\": \"https:\/\/cdn.versedb.com\/creators\/7-profile_md.webp\", \"images\": {}, \"country\": \"US\", \"appearance_types\": [\"Special Guest\"]}\n ],\n \"issues\": [],\n \"issue_variants\": [],\n \"attendees_preview\": {\n \"total\": 320,\n \"users\": [\n {\"id\": 1024, \"username\": \"comic_fan_42\", \"name\": \"Comic Fan\", \"profile_image_url\": \"https:\/\/cdn.versedb.com\/users\/1024-profile_sm.webp\", \"is_private\": false},\n {\"id\": 1536, \"username\": \"panel_pusher\", \"name\": \"Riley\", \"profile_image_url\": \"https:\/\/cdn.versedb.com\/users\/1536-profile_sm.webp\", \"is_private\": false}\n ]\n },\n \"related_events\": []\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found.\"}", "name": "Not Found or Archived" } ] } ] }, { "name": "Key Issue Reasons", "description": "\nEndpoints for browsing key issue reasons (e.g., \"1st Appearance\", \"Death\", \"Origin\").\nThese are reusable labels that can be attached to issues to indicate significance.", "item": [ { "name": "List key issue reasons.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/key-issue-reasons", "query": [ { "key": "category", "value": "appearance", "description": "Filter by category (appearance, story, creator, market, media).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/key-issue-reasons?category=appearance" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all active key issue reasons, optionally filtered by category.\nUseful for client-side pickers and filters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"1st Appearance\",\n \"category\": \"appearance\",\n \"description\": \"First appearance of a character\"\n }\n ]\n}", "name": "Success" } ] } ] }, { "name": "Comic Shops", "description": "\nEndpoints for finding and browsing comic book shops.", "item": [ { "name": "List comic shops.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/shops", "query": [ { "key": "country", "value": "US", "description": "Filter by country \u2014 accepts ISO alpha-2 code or canonical country name.", "disabled": false }, { "key": "state", "value": "NY", "description": "Filter by state or province.", "disabled": false }, { "key": "q", "value": "manhattan", "description": "Search by shop name or city.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/shops?country=US&state=NY&q=manhattan&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated shops with optional location-based and text filtering." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 42,\n \"name\": \"Midtown Comics\",\n \"city\": \"New York\",\n \"state_province\": \"NY\",\n \"country\": \"United States\",\n \"logo_url\": \"https:\/\/r2.versedb.com\/uploads\/comic-shops\/midtown-comics-42\/midtown-comics-42-abc123-tile_sm.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/r2.versedb.com\/uploads\/comic-shops\/midtown-comics-42\/midtown-comics-42-abc123-tile_sm.webp\",\n \"full_lg\": \"https:\/\/r2.versedb.com\/uploads\/comic-shops\/midtown-comics-42\/midtown-comics-42-abc123-full_lg.webp\"\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 8, \"per_page\": 20, \"total\": 150}\n}", "name": "Success" } ] }, { "name": "Get a comic shop.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/shops\/:shop_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/shops\/:shop_id", "variable": [ { "id": "shop_id", "key": "shop_id", "value": "1", "description": "The shop ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns full shop details including services offered." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 42,\n \"name\": \"Midtown Comics\",\n \"description\": \"Flagship comic shop in the heart of Manhattan.\",\n \"address\": \"200 W 40th St\",\n \"city\": \"New York\",\n \"state_province\": \"NY\",\n \"postal_code\": \"10018\",\n \"country\": \"US\",\n \"website\": \"https:\/\/www.midtowncomics.com\",\n \"full_address\": \"200 W 40th St, New York, NY 10018\",\n \"logo_url\": \"https:\/\/r2.versedb.com\/uploads\/shops\/midtown-42\/midtown-42-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/r2.versedb.com\/uploads\/shops\/midtown-42\/midtown-42-tile_sm.webp\",\n \"full_lg\": \"https:\/\/r2.versedb.com\/uploads\/shops\/midtown-42\/midtown-42-full_lg.webp\"\n },\n \"operating_hours\": {\"monday\": \"10am - 8pm\", \"saturday\": \"10am - 9pm\", \"sunday\": \"11am - 6pm\"},\n \"services\": [\"New Comics\", \"Back Issues\", \"Pull Lists\", \"Grading\"],\n \"events\": []\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\ComicShop].\"}", "name": "Not Found" } ] } ] }, { "name": "Podcasts", "description": "\nEndpoints for browsing comic book podcasts and episodes.", "item": [ { "name": "List all podcasts with optional search", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/podcasts", "query": [ { "key": "q", "value": "comic", "description": "Search by podcast name.", "disabled": false }, { "key": "type", "value": "youtube", "description": "Filter by type (podcast or youtube).", "disabled": false }, { "key": "language", "value": "en", "description": "Filter by language code (e.g., en, ja, fr).", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/podcasts?q=comic&type=youtube&language=en&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 56,\n \"name\": \"War Rocket Ajax\",\n \"slug\": \"war-rocket-ajax\",\n \"type\": \"podcast\",\n \"description\": \"A weekly comic book podcast covering new releases and creator interviews.\",\n \"language\": \"en\",\n \"logo_url\": \"https:\/\/r2.versedb.com\/uploads\/podcasts\/wra-56\/wra-56-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/r2.versedb.com\/uploads\/podcasts\/wra-56\/wra-56-tile_sm.webp\",\n \"full_lg\": \"https:\/\/r2.versedb.com\/uploads\/podcasts\/wra-56\/wra-56-full_lg.webp\"\n },\n \"follower_count\": 1240,\n \"subscriber_count\": 8800,\n \"categories\": [\"Comics\", \"Pop Culture\"]\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 15, \"per_page\": 20, \"total\": 300}\n}", "name": "Success" } ] }, { "name": "Get a specific podcast.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/podcasts\/:podcast_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/podcasts\/:podcast_id", "variable": [ { "id": "podcast_id", "key": "podcast_id", "value": "238", "description": "The ID of the podcast." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 56,\n \"name\": \"War Rocket Ajax\",\n \"slug\": \"war-rocket-ajax\",\n \"type\": \"podcast\",\n \"description\": \"A weekly comic book podcast covering new releases, industry news, and creator interviews.\",\n \"language\": \"en\",\n \"logo_url\": \"https:\/\/r2.versedb.com\/uploads\/podcasts\/wra-56\/wra-56-full_lg.webp\",\n \"images\": {\n \"tile_sm\": \"https:\/\/r2.versedb.com\/uploads\/podcasts\/wra-56\/wra-56-tile_sm.webp\",\n \"full_lg\": \"https:\/\/r2.versedb.com\/uploads\/podcasts\/wra-56\/wra-56-full_lg.webp\"\n },\n \"website_url\": \"https:\/\/warrocketajax.com\",\n \"rss_feed_url\": \"https:\/\/feeds.example.com\/war-rocket-ajax\",\n \"youtube_channel_id\": null,\n \"social_links\": {\"website\": \"https:\/\/warrocketajax.com\", \"twitter\": \"https:\/\/twitter.com\/warrocketajax\"},\n \"platform_links\": {\"apple\": \"https:\/\/podcasts.apple.com\/us\/podcast\/id123456\", \"spotify\": \"https:\/\/open.spotify.com\/show\/abc123\"},\n \"follower_count\": 1240,\n \"subscriber_count\": 8800,\n \"categories\": [\"Comics\", \"Pop Culture\"]\n }\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Podcast].\"}", "name": "Not Found" } ] } ] }, { "name": "Lists", "description": "\nUser-generated and curated lists of comic content.\n\nLists allow users to organize and share collections of issues, series, characters, creators, teams, or story arcs.\nUsers can save and like lists, and lists can be ranked or unranked.\n\n**Entity Types:** issues, series, characters, creators, story_arcs, teams\n\n**List Types:**\n- `custom` - User-created lists\n- `system` - Platform-curated lists (no owner)\n- `wishlist` - User's default wishlist (cannot be deleted)", "item": [ { "name": "Browse lists.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists", "query": [ { "key": "q", "value": "spider-man", "description": "Search by list title.", "disabled": false }, { "key": "entity_type", "value": "issues", "description": "Filter by entity type (issues, series, characters, creators, story_arcs, teams).", "disabled": false }, { "key": "sort", "value": "popular", "description": "Sort order (featured, newest, popular, most_saved). Default: featured.", "disabled": false }, { "key": "limit", "value": "20", "description": "Items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/lists?q=spider-man&entity_type=issues&sort=popular&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated public lists with filtering and sorting options.\nOnly shows lists with at least one item." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 101,\n \"title\": \"Best Spider-Man Stories\",\n \"entity_type\": \"issues\",\n \"is_ranked\": true,\n \"items_count\": 25,\n \"likes_count\": 150,\n \"saves_count\": 89,\n \"user\": {\"id\": 123, \"username\": \"comic_fan\", \"avatar\": \"https:\/\/...\"},\n \"preview_items\": [{\"id\": 1, \"image_url\": \"https:\/\/...\", \"is_nsfw\": false}]\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 5, \"per_page\": 20, \"total\": 100}\n}", "name": "Success" } ] }, { "name": "Browse system lists.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/system", "query": [ { "key": "entity_type", "value": "issues", "description": "Filter by entity type (issues, series, characters, creators, story_arcs, teams).", "disabled": false }, { "key": "sort", "value": "popular", "description": "Sort order (newest, popular).", "disabled": false }, { "key": "limit", "value": "20", "description": "Items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/lists\/system?entity_type=issues&sort=popular&limit=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns platform-curated lists (no user owner). These are editorial picks and featured content." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Essential Batman Reading Order\",\n \"entity_type\": \"issues\",\n \"is_ranked\": true,\n \"items_count\": 50,\n \"likes_count\": 500,\n \"user\": null,\n \"preview_items\": [{\"id\": 1, \"image_url\": \"https:\/\/...\", \"is_nsfw\": false}]\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 2, \"per_page\": 20, \"total\": 30}\n}", "name": "Success" } ] }, { "name": "Get list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single list with all its items. Private lists are only visible to owners." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 101,\n \"title\": \"Best Spider-Man Stories\",\n \"description\": \"My favorite Spidey moments\",\n \"entity_type\": \"issues\",\n \"is_ranked\": true,\n \"is_private\": false,\n \"items_count\": 25,\n \"likes_count\": 150,\n \"saves_count\": 89,\n \"user\": {\"id\": 123, \"username\": \"comic_fan\", \"name\": \"John\"},\n \"items\": [\n {\"id\": 1, \"position\": 1, \"note\": \"Classic!\", \"listable\": {\"id\": 5432, \"number\": \"1\"}}\n ],\n \"created_at\": \"2024-01-15T10:30:00Z\"\n }\n}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"This list is private.\"\n}", "name": "Private List" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Not Found\"\n}", "name": "Not Found" } ] }, { "name": "Get user's lists.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/lists", "query": [ { "key": "entity_type", "value": "issues", "description": "Filter by entity type (issues, series, etc.).", "disabled": false }, { "key": "sort", "value": "newest", "description": "Sort order (newest, popular, most_saved).", "disabled": false }, { "key": "limit", "value": "20", "description": "Items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/lists?entity_type=issues&sort=newest&limit=20", "variable": [ { "id": "user_id", "key": "user_id", "value": "123", "description": "The user ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a user's public lists. If viewing your own profile, also includes private lists." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 101,\n \"title\": \"My Reading List\",\n \"entity_type\": \"issues\",\n \"items_count\": 15,\n \"is_private\": false,\n \"user\": {\"id\": 123, \"username\": \"comic_fan\"}\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 20, \"total\": 5}\n}", "name": "Success" } ] }, { "name": "Create list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Best Spider-Man Stories\",\"description\":\"My favorite Spidey moments ranked\",\"entity_type\":\"issues\",\"is_ranked\":true,\"is_private\":false}" }, "description": "Creates a new user list." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 102,\n \"title\": \"Best Spider-Man Stories\",\n \"description\": \"My favorite Spidey moments ranked\",\n \"entity_type\": \"issues\",\n \"is_ranked\": true,\n \"is_private\": false,\n \"items_count\": 0,\n \"user\": {\"id\": 123, \"username\": \"comic_fan\"}\n }\n}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"You have reached the maximum number of lists. Upgrade to PRO for more.\"\n}", "name": "Limit Reached" } ] }, { "name": "Update list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Updated Title\",\"description\":\"Updated description\",\"is_ranked\":false,\"is_private\":true,\"status\":\"published\"}" }, "description": "Updates a list's metadata. Wishlists can only update privacy settings." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\"id\": 101, \"title\": \"Updated Title\", \"description\": \"Updated description\"}\n}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"This action is unauthorized.\"\n}", "name": "Unauthorized" } ] }, { "name": "Convert a list to mixed.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/convert-to-mixed", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/convert-to-mixed", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One-way: broadens a single-type list so it can hold items of any type. Existing items keep\ntheir own type. A mixed list cannot be narrowed back, and wishlists cannot be converted." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\"id\": 101, \"entity_type\": \"mixed\"}\n}", "name": "Converted" }, { "header": [], "code": 403, "body": "{\n \"message\": \"This action is unauthorized.\"\n}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\n \"message\": \"This list is already a mixed list.\"\n}", "name": "Not convertible" } ] }, { "name": "Merge a list into this one.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/merge", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/merge", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The destination list ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"source_list_id\":207,\"delete_source\":false}" }, "description": "Pulls every item from the source list into this (destination) list \u2014 skipping items already\npresent (by entity + variant) and appending the rest. Both lists must be owned by the\nauthenticated user. Merging items of a different type converts this list to `mixed`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\"id\": 101, \"title\": \"Best Batman Runs\", \"item_types\": [\"issues\"]},\n \"merge\": {\"moved\": 4, \"skipped_duplicates\": 1, \"converted_to_mixed\": false, \"source_deleted\": false}\n}", "name": "Merged" }, { "header": [], "code": 403, "body": "{\n \"message\": \"You can only merge into your own lists.\"\n}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The source list has no items to merge.\"\n}", "name": "Invalid merge" } ] }, { "name": "Delete list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes a list and all its items. Wishlists cannot be deleted." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Wishlists cannot be deleted.\"\n}", "name": "Wishlist" }, { "header": [], "code": 403, "body": "{\n \"message\": \"You are not authorized to delete this list.\"\n}", "name": "Unauthorized" } ] }, { "name": "Add item to list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/items", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/items", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"entity_id\":5432,\"entity_type\":\"issues\",\"position\":1,\"note\":\"My favorite issue!\"}" }, "description": "Adds an entity to a list. Free users: 100 items\/list, PRO users: 500 items\/list." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\"id\": 501, \"position\": 1, \"note\": \"My favorite issue!\", \"listable\": {\"id\": 5432, \"number\": \"1\"}}\n}", "name": "Added" }, { "header": [], "code": 403, "body": "{\n \"message\": \"This list has reached its item limit. Upgrade to PRO for more.\"\n}", "name": "Item Limit" }, { "header": [], "code": 409, "body": "{\n \"message\": \"This item is already in the list.\",\n \"item\": {\"id\": 501, \"position\": 1}\n}", "name": "Already Exists" } ] }, { "name": "Remove item from list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/items\/:item_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/items\/:item_id", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." }, { "id": "item_id", "key": "item_id", "value": "501", "description": "The list item ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes an item from a list. Other items' positions are automatically adjusted." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"You are not authorized to remove items from this list.\"\n}", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Item does not belong to this list.\"\n}", "name": "Not Found" } ] }, { "name": "Reorder items.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/items\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/items\/reorder", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"item_ids\":[503,501,502]}" }, "description": "Reorders items in a list by providing the new order of item IDs." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Items reordered successfully.\",\n \"items\": [\n {\"id\": 503, \"position\": 1, \"note\": null, \"entity_type\": \"issues\", \"entity\": {\"id\": 5432, \"name\": \"The Amazing Spider-Man #1\", \"issue_number\": \"1\", \"image_url\": \"https:\/\/...\"}},\n {\"id\": 501, \"position\": 2, \"note\": null, \"entity_type\": \"issues\", \"entity\": {\"id\": 5433, \"name\": \"The Amazing Spider-Man #2\", \"issue_number\": \"2\", \"image_url\": \"https:\/\/...\"}},\n {\"id\": 502, \"position\": 3, \"note\": null, \"entity_type\": \"issues\", \"entity\": {\"id\": 5434, \"name\": \"The Amazing Spider-Man #3\", \"issue_number\": \"3\", \"image_url\": \"https:\/\/...\"}}\n ]\n}", "name": "Success" } ] }, { "name": "Save list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/save", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/save", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Saves a list to the user's saved lists for quick access. Cannot save your own lists." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"List is already saved.\",\n \"saved\": true\n}", "name": "Already Saved" }, { "header": [], "code": 201, "body": "{\n \"message\": \"List saved successfully.\",\n \"saved\": true,\n \"saves_count\": 90\n}", "name": "Saved" }, { "header": [], "code": 403, "body": "{\n \"message\": \"You cannot save your own list.\"\n}", "name": "Own List" } ] }, { "name": "Unsave list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/save", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/save", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes a list from the user's saved lists." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"List unsaved successfully.\",\n \"saved\": false,\n \"saves_count\": 89\n}", "name": "Unsaved" }, { "header": [], "code": 200, "body": "{\n \"message\": \"List is not saved.\",\n \"saved\": false\n}", "name": "Not Saved" } ] }, { "name": "Like list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/like", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/like", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Likes a list. Cannot like your own lists." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"List is already liked.\",\n \"liked\": true\n}", "name": "Already Liked" }, { "header": [], "code": 201, "body": "{\n \"message\": \"List liked successfully.\",\n \"liked\": true,\n \"likes_count\": 151\n}", "name": "Liked" }, { "header": [], "code": 403, "body": "{\n \"message\": \"You cannot like your own list.\"\n}", "name": "Own List" } ] }, { "name": "Unlike list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lists\/:list_id\/like", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lists\/:list_id\/like", "variable": [ { "id": "list_id", "key": "list_id", "value": "101", "description": "The list ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the user's like from a list." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"List unliked successfully.\",\n \"liked\": false,\n \"likes_count\": 150\n}", "name": "Unliked" }, { "header": [], "code": 200, "body": "{\n \"message\": \"List is not liked.\",\n \"liked\": false\n}", "name": "Not Liked" } ] } ] }, { "name": "Barcode Lookup", "description": "\nEndpoints for looking up comics by barcode (UPC or ISBN).\nUsed by the mobile app's barcode scanning feature and exposed\nto User API tokens via the `lookup:barcode` ability.\n\nRequires the `mobile:lookup` or `lookup:barcode` token ability.", "item": [ { "name": "Lookup by UPC.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lookup\/upc\/:upc", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lookup\/upc\/:upc", "variable": [ { "id": "upc", "key": "upc", "value": "75960608936700111", "description": "The UPC barcode." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find an issue by its UPC barcode (typically 12-17 digits).\nReturns full issue details including series information." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 5432,\n \"slug\": \"amazing-spider-man-1\",\n \"series_id\": 123,\n \"title_id\": 45,\n \"issue_number\": \"1\",\n \"name\": \"The Amazing Spider-Man #1\",\n \"description\": \"Nick Spencer and Ryan Ottley begin a new era...\",\n \"release_date\": \"2018-07-11\",\n \"cover_date\": \"2018-09-01\",\n \"cover_url\": \"https:\/\/...\",\n \"upc\": \"75960608936700111\",\n \"series\": {\"id\": 123, \"name\": \"Amazing Spider-Man\", \"slug\": \"amazing-spider-man-2018\", \"start_year\": 2018, \"volume_number\": 5},\n \"publisher\": {\"id\": 1, \"name\": \"Marvel\", \"slug\": \"marvel\"}\n },\n \"suggested_variant_id\": 789,\n \"variants\": [\n {\"variant_id\": null, \"variant_name\": \"Cover A\", \"cover_url\": \"https:\/\/...\"},\n {\"variant_id\": 789, \"variant_name\": \"Cover B\", \"cover_url\": \"https:\/\/...\"}\n ]\n}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Unauthorized\"\n}", "name": "Missing Ability" }, { "header": [], "code": 404, "body": "{\n \"message\": \"No issue found with UPC: 75960608936700111\"\n}", "name": "Not Found" }, { "header": [], "code": 409, "body": "{\n \"message\": \"Multiple issues share UPC: 075960608936. Pick one below.\",\n \"count\": 3,\n \"matches\": [\n {\n \"issue_id\": 5432,\n \"series_name\": \"Amazing Spider-Man\",\n \"series_id\": 123,\n \"issue_number\": \"1\",\n \"cover_url\": \"https:\/\/...\",\n \"variant_name\": null,\n \"suggested_variant_id\": null,\n \"variants\": [{\"variant_id\": null, \"variant_name\": \"Cover A\", \"cover_url\": \"https:\/\/...\"}],\n \"publisher_name\": \"Marvel\",\n \"release_date\": \"1990-04-01\",\n \"start_year\": 1963\n }\n ]\n}", "name": "Multiple Matches" } ] }, { "name": "Lookup by ISBN.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lookup\/isbn\/:isbn", "query": [], "raw": "{{baseUrl}}\/api\/v1\/lookup\/isbn\/:isbn", "variable": [ { "id": "isbn", "key": "isbn", "value": "978-1302913847", "description": "The ISBN (10 or 13 digits)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find an issue by its ISBN (10 or 13 digits, with or without dashes).\nCommonly used for trade paperbacks and hardcovers.\nReturns full issue details including series information." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 8765,\n \"slug\": \"spider-man-life-story-tp\",\n \"series_id\": 456,\n \"title_id\": 45,\n \"issue_number\": \"1\",\n \"name\": \"Spider-Man: Life Story TP\",\n \"description\": \"A story of Peter Parker...\",\n \"release_date\": \"2019-10-02\",\n \"isbn\": \"978-1302913847\",\n \"format\": \"trade_paperback\",\n \"series\": {\"id\": 456, \"name\": \"Spider-Man: Life Story\", \"slug\": \"spider-man-life-story\"},\n \"publisher\": {\"id\": 1, \"name\": \"Marvel\", \"slug\": \"marvel\"}\n }\n}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Unauthorized\"\n}", "name": "Missing Ability" }, { "header": [], "code": 404, "body": "{\n \"message\": \"No issue found with ISBN: 978-1302913847\"\n}", "name": "Not Found" } ] } ] }, { "name": "User", "description": "\nEndpoints for managing the authenticated user's pull list, follows, and reading progress.\n\nAll endpoints in this group require authentication via a mobile session token.", "item": [ { "name": "Get the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user", "query": [], "raw": "{{baseUrl}}\/api\/v1\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the profile of the user the token belongs to." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "299" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "{\"data\":{\"id\":14,\"name\":\"Scribe Test User\",\"username\":\"scribe-test-user\",\"email\":\"scribe-tester@internal.versedb.com\",\"bio\":null,\"avatar\":null,\"profile_image\":null,\"profile_image_url\":null,\"glow_color\":\"#FF5722\",\"banner_path\":null,\"banner_url\":null,\"country_code\":null,\"city\":null,\"region\":null,\"postal_code\":null,\"formatted_location\":null,\"is_private\":false,\"is_wishlist_public\":false,\"public_wishlist_id\":null,\"email_notifications\":true,\"content_edit_notifications\":true,\"comment_reply_notifications\":true,\"push_notifications_enabled\":true,\"inapp_notifications_enabled\":true,\"show_nsfw_warnings\":true,\"birth_date\":null,\"can_view_nsfw\":false,\"show_reading_list\":true,\"show_collection\":true,\"show_activity\":true,\"show_spoilers\":false,\"preferred_mediums\":[\"comic\"],\"preferred_genres\":[],\"preferred_languages\":[\"en\"],\"locale\":null,\"onboarding_completed_at\":\"2025-04-11T01:29:50.000000Z\",\"onboarding_step\":5,\"ai_discovery_enabled\":true,\"is_pro\":false,\"level\":1,\"xp\":0,\"xp_for_next_level\":100,\"xp_progress_percent\":0,\"contributions_count\":0,\"level_name\":\"Bystander\",\"created_at\":\"2025-04-11T01:29:50.000000Z\",\"updated_at\":\"2025-04-11T01:29:50.000000Z\",\"has_password\":true,\"deletion_requested_at\":null,\"deletion_confirmed_at\":null,\"deletion_scheduled_for\":null}}", "name": "" } ] }, { "name": "Collections", "description": "", "item": [ { "name": "List collection.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/collections", "query": [ { "key": "per_page", "value": "20", "description": "Items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "search", "value": "spider", "description": "Filter by issue name, issue number, or series name.", "disabled": false }, { "key": "format", "value": "single", "description": "Filter by stored format.", "disabled": false }, { "key": "graded", "value": "1", "description": "Filter to graded (true) or raw (false) copies.", "disabled": false }, { "key": "is_signed", "value": "1", "description": "Filter to signed (true) or unsigned (false) copies.", "disabled": false }, { "key": "condition", "value": "NM", "description": "Filter by condition grade code.", "disabled": false }, { "key": "for_sale", "value": "1", "description": "Filter to copies marked for sale.", "disabled": false }, { "key": "for_trade", "value": "1", "description": "Filter to copies marked for trade.", "disabled": false }, { "key": "read_status", "value": "unread", "description": "Filter by read state. One of: read, unread.", "disabled": false }, { "key": "publisher_id", "value": "1", "description": "Filter to issues from a publisher.", "disabled": false }, { "key": "grade_min", "value": "9", "description": "Filter to copies with a numeric grade at or above this value.", "disabled": false }, { "key": "grade_max", "value": "9.8", "description": "Filter to copies with a numeric grade at or below this value.", "disabled": false }, { "key": "sort_by", "value": "title", "description": "Sort field. One of: date_added, title, release_date, estimated_value, price_paid.", "disabled": false }, { "key": "sort_order", "value": "asc", "description": "Sort direction. One of: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/user\/collections?per_page=20&page=1&search=spider&format=single&graded=1&is_signed=1&condition=NM&for_sale=1&for_trade=1&read_status=unread&publisher_id=1&grade_min=9&grade_max=9.8&sort_by=title&sort_order=asc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all issues in the user's collection with series and publisher info." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1001,\n \"user_id\": 42,\n \"collectable_type\": \"Issue\",\n \"collectable_id\": 5432,\n \"variant_id\": null,\n \"condition\": \"NM\",\n \"purchased_at\": \"2024-01-15\",\n \"notes\": \"First print\",\n \"format\": \"single\",\n \"storage_location\": \"Long box 3\",\n \"price_paid\": 3.99,\n \"is_variant\": false,\n \"variant_description\": null,\n \"variant_type\": null,\n \"graded\": true,\n \"grade_score\": \"9.8\",\n \"grading_company\": \"CGC\",\n \"grading_number\": \"1234567001\",\n \"label_type\": \"universal\",\n \"page_quality\": \"white\",\n \"grader_notes\": null,\n \"purchase_source\": \"lcs\",\n \"comic_shop_id\": 17,\n \"comic_shop\": {\"id\": 17, \"name\": \"Comic Corner\", \"slug\": \"comic-corner\", \"city\": \"Portland\", \"state_province\": \"OR\"},\n \"acquisition_method\": \"purchased\",\n \"is_signed\": false,\n \"signed_by\": null,\n \"signature_witness\": null,\n \"signature_authenticated\": false,\n \"is_cgc_ss\": false,\n \"print_number\": 1,\n \"estimated_value\": 25.00,\n \"value_last_updated\": \"2024-06-01T00:00:00Z\",\n \"for_sale\": false,\n \"for_trade\": false,\n \"is_public\": true,\n \"cover_scan_url\": null,\n \"cover_scan_url_lg\": null,\n \"cover_scan_uploaded_at\": null,\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\",\n \"collectable\": {\n \"id\": 5432,\n \"slug\": \"example-series-1\",\n \"series_id\": 123,\n \"issue_number\": \"1\",\n \"name\": \"First Issue\",\n \"cover_date\": \"2023-11-01\",\n \"release_date\": \"2023-11-08\",\n \"foc_date\": \"2023-10-16\",\n \"cover_url\": \"https:\/\/versedb.com\/storage\/issues\/5432\/cover_lg.jpg\",\n \"images\": {\n \"thumb\": \"https:\/\/versedb.com\/storage\/issues\/5432\/thumb.jpg\",\n \"cover_sm\": \"https:\/\/versedb.com\/storage\/issues\/5432\/cover_sm.jpg\",\n \"cover_md\": \"https:\/\/versedb.com\/storage\/issues\/5432\/cover_md.jpg\",\n \"cover_lg\": \"https:\/\/versedb.com\/storage\/issues\/5432\/cover_lg.jpg\"\n },\n \"is_reprint\": false,\n \"age_rating\": null,\n \"is_nsfw\": false,\n \"average_rating\": 4.5,\n \"series\": {\n \"id\": 123,\n \"name\": \"Example Series\",\n \"slug\": \"example-series\",\n \"start_year\": 2023,\n \"end_year\": null,\n \"volume_number\": 1,\n \"publication_type\": \"ongoing\",\n \"format\": \"single\",\n \"cached_issues_count\": 12,\n \"cover_url\": \"https:\/\/versedb.com\/storage\/series\/123\/cover_lg.jpg\",\n \"images\": {\n \"cover_sm\": \"https:\/\/versedb.com\/storage\/series\/123\/cover_sm.jpg\",\n \"cover_md\": \"https:\/\/versedb.com\/storage\/series\/123\/cover_md.jpg\",\n \"cover_lg\": \"https:\/\/versedb.com\/storage\/series\/123\/cover_lg.jpg\"\n },\n \"publisher_name\": \"Example Publisher\"\n },\n \"key_issue_reasons\": [\n {\"id\": 7, \"name\": \"First appearance\", \"category\": \"appearance\", \"slug\": \"first-appearance\", \"notes\": null}\n ]\n }\n }\n ],\n \"links\": {\"first\": \"...\", \"last\": \"...\", \"prev\": null, \"next\": \"...\"},\n \"meta\": {\"current_page\": 1, \"from\": 1, \"last_page\": 5, \"path\": \"...\", \"per_page\": 20, \"to\": 20, \"total\": 100}\n}", "name": "Success" } ] }, { "name": "Check issue in collection.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/collection\/check", "query": [ { "key": "variant_id", "value": "789", "description": "Specific variant ID to check (optional).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/collection\/check?variant_id=789", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variant_id\":789}" }, "description": "Checks if an issue (optionally a specific variant) is in the user's collection." }, "response": [ { "header": [], "code": 200, "body": "{\n \"in_collection\": true,\n \"copies_count\": 1,\n \"copies\": [\n {\"id\": 1001, \"variant_id\": 789, \"condition\": \"NM\", \"graded\": true, \"grade_score\": \"9.8\", \"grading_company\": \"CGC\", \"notes\": \"First print\", \"created_at\": \"2024-01-15T10:30:00Z\"}\n ],\n \"data\": {\"id\": 1001, \"condition\": \"NM\", \"price_paid\": 4.99, \"issue\": {\"id\": 5432, \"name\": \"The Amazing Spider-Man #1\", \"issue_number\": \"1\"}}\n}", "name": "In Collection" }, { "header": [], "code": 200, "body": "{\n \"in_collection\": false,\n \"copies_count\": 0,\n \"copies\": [],\n \"data\": null\n}", "name": "Not in Collection" } ] }, { "name": "Add issue to collection.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/collection", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/collection", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variant_id\":789,\"condition\":\"NM\",\"notes\":\"First print, signed\",\"price_paid\":4.99,\"format\":\"standard\",\"purchase_source\":\"comic_shop\",\"comic_shop_id\":412,\"acquisition_method\":\"purchase\",\"purchased_at\":\"2024-06-15\",\"storage_location\":\"Long box #3\",\"is_signed\":false,\"signed_by\":\"Stan Lee\",\"is_variant\":false,\"variant_description\":\"Skottie Young baby variant\",\"variant_type\":\"cover_variant\",\"graded\":false,\"grade_score\":\"9.8\",\"grading_company\":\"CGC\",\"grading_number\":\"1234567890\",\"label_type\":\"universal\",\"page_quality\":\"white\",\"grader_notes\":\"Marvel Value Stamp #16 intact\",\"print_number\":\"1st\",\"signature_witness\":\"witnessed_in_person\",\"estimated_value\":25,\"for_sale\":false,\"for_trade\":false,\"is_public\":true}" }, "description": "Adds an issue to the user's default collection. Works for all users (no PRO required).\nThis is the recommended endpoint for mobile collection management." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 1001,\n \"issue\": {\"id\": 5432, \"number\": \"1\", \"title\": \"First Issue\"},\n \"series\": {\"id\": 123, \"name\": \"Amazing Spider-Man\"},\n \"variant_id\": null,\n \"condition\": \"NM\",\n \"price_paid\": 4.99,\n \"notes\": \"First print, signed\"\n }\n}", "name": "Added" }, { "header": [], "code": 403, "body": "{\n \"error\": \"Cannot add to collection while account is pending deletion.\"\n}", "name": "Account Pending Deletion" }, { "header": [], "code": 422, "body": "{\n \"error\": \"Variant does not belong to this issue.\"\n}", "name": "Invalid Variant" } ] }, { "name": "Update collection item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/collection", "query": [ { "key": "variant_id", "value": "789", "description": "Specific variant ID to update (when user has multiple entries).", "disabled": false }, { "key": "collection_item_id", "value": "1001", "description": "Specific collection item ID to update.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/collection?variant_id=789&collection_item_id=1001", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variant_id\":42,\"condition\":\"NM\",\"notes\":\"First print, great condition\",\"price_paid\":3.99,\"format\":\"standard\",\"purchase_source\":\"comic_shop\",\"comic_shop_id\":412,\"acquisition_method\":\"purchase\",\"purchased_at\":\"2024-06-15\",\"storage_location\":\"Long box #3\",\"is_signed\":false,\"signed_by\":\"Stan Lee\",\"is_variant\":false,\"variant_description\":\"Skottie Young baby variant\",\"variant_type\":\"cover_variant\",\"graded\":false,\"grade_score\":\"9.8\",\"grading_company\":\"CGC\",\"grading_number\":\"1234567890\",\"label_type\":\"universal\",\"page_quality\":\"white\",\"grader_notes\":\"Marvel Value Stamp #16 intact\",\"print_number\":\"1st\",\"signature_witness\":\"witnessed_in_person\",\"estimated_value\":25,\"for_sale\":false,\"for_trade\":false,\"is_public\":true,\"is_read\":true,\"read_at\":\"2024-06-15\"}" }, "description": "Updates metadata on an existing collection entry for an issue.\nSupports partial updates \u2014 only send the fields you want to change." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\"id\": 1001, \"condition\": \"NM\", \"price_paid\": 4.99, \"graded\": true}\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Issue not found in your collection.\"\n}", "name": "Not Found" } ] }, { "name": "Remove issue from collection.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/collection", "query": [ { "key": "variant_id", "value": "789", "description": "Specific variant ID to remove (optional).", "disabled": false }, { "key": "collection_item_id", "value": "1001", "description": "Specific collection item ID to remove (optional).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/collection?variant_id=789&collection_item_id=1001", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variant_id\":789,\"collection_item_id\":1001}" }, "description": "Removes an issue (optionally a specific variant) from the user's collection." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Issue not found in your collection.\"\n}", "name": "Not Found" } ] } ] }, { "name": "Pull List", "description": "", "item": [ { "name": "List pull list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/pull-list", "query": [ { "key": "per_page", "value": "20", "description": "Items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/user\/pull-list?per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all series on the user's pull list (series they're tracking for new releases)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 123,\n \"series\": {\n \"id\": 456,\n \"name\": \"Amazing Spider-Man\",\n \"publisher\": {\"id\": 1, \"name\": \"Marvel\"},\n \"cover_url\": \"...\"\n },\n \"added_at\": \"2024-01-15T10:30:00Z\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 2, \"per_page\": 20, \"total\": 35}\n}", "name": "Success" } ] }, { "name": "Add to pull list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pull-list\/items", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pull-list\/items" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"series_id\":456}" }, "description": "Adds a series to the user's pull list to track new releases." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The selected series id is invalid.\",\n \"errors\": {\"series_id\": [\"The selected series id is invalid.\"]}\n}", "name": "Series Not Found" } ] }, { "name": "Remove from pull list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pull-list\/items\/:item_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pull-list\/items\/:item_id", "variable": [ { "id": "item_id", "key": "item_id", "value": "456", "description": "The series ID of the pull list entry." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Removed" } ] } ] }, { "name": "Read Status", "description": "", "item": [ { "name": "List read status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/read-status", "query": [ { "key": "per_page", "value": "20", "description": "Items per page (max 100).", "disabled": false }, { "key": "unreviewed", "value": "1", "description": "When true, only returns reads for issues the user has not yet reviewed.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/user\/read-status?per_page=20&unreviewed=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all issues the user has marked as read with timestamps." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1234,\n \"issue\": {\"id\": 5432, \"number\": \"1\", \"title\": \"First Issue\"},\n \"series\": {\"id\": 123, \"name\": \"Amazing Spider-Man\"},\n \"variant_id\": null,\n \"read_at\": \"2024-01-15T10:30:00Z\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 10, \"per_page\": 20, \"total\": 200}\n}", "name": "Success" } ] }, { "name": "Mark as read.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/read-status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/read-status", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variant_id\":789}" }, "description": "Marks an issue (optionally a specific variant) as read with the current timestamp." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success" }, { "header": [], "code": 422, "body": "{\n \"error\": \"Variant does not belong to this issue\"\n}", "name": "Invalid Variant" } ] }, { "name": "Edit reading date.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/read-status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/read-status", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"read_at\":\"2026-03-01\",\"variant_id\":789}" }, "description": "Updates the `read_at` date on an existing read entry, or removes the entry when `read_at` is null.\nIf no entry exists yet and a date is provided, one is created (upsert)." }, "response": [ { "header": [], "code": 200, "body": "{\"read_at\": \"2026-03-01T00:00:00+00:00\"}", "name": "Updated" }, { "header": [], "code": 204, "body": "{}", "name": "Cleared (read_at was null)" } ] }, { "name": "Mark as unread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/read-status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/read-status", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variant_id\":789}" }, "description": "Removes the read status for an issue (optionally a specific variant)." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" } ] } ] }, { "name": "Wishlist", "description": "", "item": [ { "name": "List wishlist.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/wishlist", "query": [ { "key": "per_page", "value": "20", "description": "Items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/user\/wishlist?per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the authenticated user's wishlist items (issues), most recently added first." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 9876,\n \"position\": null,\n \"note\": null,\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\",\n \"variant_id\": null,\n \"entity_type\": \"issues\",\n \"entity\": {\n \"id\": 5432,\n \"name\": \"Amazing Spider-Man #1\",\n \"issue_number\": \"1\",\n \"image_url\": \"...\",\n \"publisher\": \"Marvel\",\n \"series\": {\"id\": 123, \"name\": \"Amazing Spider-Man\", \"start_year\": 2018}\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 20, \"total\": 4}\n}", "name": "Success" } ] }, { "name": "Add to wishlist.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/wishlist", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/wishlist", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Adds the issue to the authenticated user's wishlist. Idempotent \u2014 calling\nwith an issue already on the wishlist returns 200 without creating a duplicate." }, "response": [ { "header": [], "code": 200, "body": "{\n \"in_wishlist\": true\n}", "name": "Already in Wishlist" }, { "header": [], "code": 201, "body": "{\n \"in_wishlist\": true\n}", "name": "Added" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Wishlist is full (max 500 items).\"\n}", "name": "Wishlist Full" } ] }, { "name": "Remove from wishlist.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/issues\/:issue_id\/wishlist", "query": [], "raw": "{{baseUrl}}\/api\/v1\/issues\/:issue_id\/wishlist", "variable": [ { "id": "issue_id", "key": "issue_id", "value": "5432", "description": "The issue ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the issue from the authenticated user's wishlist. Idempotent \u2014\nreturns 204 whether or not the issue was on the wishlist." }, "response": [ { "header": [], "code": 204, "body": "", "name": "Removed" } ] } ] }, { "name": "Follows", "description": "", "item": [ { "name": "List follows.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/follows", "query": [ { "key": "per_page", "value": "20", "description": "Items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/user\/follows?per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all entities the user is following (titles, characters, podcasts, etc.)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 789,\n \"followable_type\": \"title\",\n \"followable_id\": 123,\n \"followable\": {\"id\": 123, \"name\": \"Spider-Man\", \"cover_url\": \"...\"},\n \"created_at\": \"2024-01-15T10:30:00Z\"\n }\n ],\n \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 20, \"total\": 12}\n}", "name": "Success" } ] }, { "name": "Follow content.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/follow", "query": [], "raw": "{{baseUrl}}\/api\/v1\/follow" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"title\",\"id\":45,\"preferences\":{\"email_notifications\":true,\"push_notifications\":false}}" }, "description": "Follows a title, character, podcast, creator, publisher, team, story arc, comic shop, event, or user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Following title successfully\",\n \"is_following\": true\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Title not found\"\n}", "name": "Not Found" } ] }, { "name": "Unfollow content.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/follow\/:type\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/follow\/:type\/:id", "variable": [ { "id": "type", "key": "type", "value": "title", "description": "The content type (title, character, podcast, creator, publisher, team, story_arc, comic_shop, event, user)." }, { "id": "id", "key": "id", "value": "45", "description": "The ID of the followed content." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Unfollowed title successfully\",\n \"is_following\": false\n}", "name": "Success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Title not found\"\n}", "name": "Not Found" } ] }, { "name": "Check follow status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/follow\/:type\/:id\/check", "query": [], "raw": "{{baseUrl}}\/api\/v1\/follow\/:type\/:id\/check", "variable": [ { "id": "type", "key": "type", "value": "title", "description": "The content type (title, character, podcast, creator, publisher, team, story_arc, comic_shop, event, user)." }, { "id": "id", "key": "id", "value": "45", "description": "The ID of the content." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"is_following\": true\n}", "name": "Success" } ] } ] }, { "name": "Activity", "description": "", "item": [ { "name": "Get activity feed.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/activity", "query": [ { "key": "per_page", "value": "20", "description": "Number of results per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/user\/activity?per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Aggregates recent activity from collections, reads, follows, and reviews." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"collection_9921\",\n \"type\": \"collection\",\n \"action\": \"added_to_collection\",\n \"created_at\": \"2026-06-20T14:32:00+00:00\",\n \"data\": {\n \"issue_id\": 5432,\n \"issue_name\": \"Amazing Spider-Man #1\",\n \"series_name\": \"Amazing Spider-Man\",\n \"cover_url\": \"https:\/\/r2.versedb.com\/uploads\/issues\/asm-5432\/asm-5432-cover_md.webp\"\n }\n },\n {\n \"id\": \"review_312\",\n \"type\": \"review\",\n \"action\": \"wrote_review\",\n \"created_at\": \"2026-06-19T09:10:00+00:00\",\n \"data\": {\n \"review_id\": 312,\n \"issue_id\": 5410,\n \"issue_name\": \"Batman #135\",\n \"series_name\": \"Batman\",\n \"rating\": 4.5,\n \"content_preview\": \"A strong anniversary issue that pays off years of buildup...\",\n \"cover_url\": \"https:\/\/r2.versedb.com\/uploads\/issues\/batman-5410\/batman-5410-cover_md.webp\"\n }\n }\n ],\n \"meta\": {\"current_page\": 1, \"per_page\": 20, \"total\": 84, \"last_page\": 5}\n}", "name": "Success" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }