{
"variable": [
{
"id": "baseUrl",
"key": "baseUrl",
"type": "string",
"name": "string",
"value": "https:\/\/forge.sp-tarkov.com"
}
],
"info": {
"name": "The Forge API Documentation",
"_postman_id": "8c9cae0c-609e-4f29-b7c5-a9d66203a0de",
"description": "The greatest resource available for Single Player Tarkov modifications. Where modding legends are made. Discover powerful tools, expert-written guides, and exclusive mods. Craft your vision. Transform the game.",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
},
"item": [
{
"name": "General",
"description": "\nAPIs for general application status and information.",
"item": [
{
"name": "Check API Health",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/ping",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/ping"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Returns a simple 'pong' message to indicate that the API endpoint\nis available and responding correctly. This endpoint is typically used\nfor health checks or basic connectivity tests.\n\nIt does not require authentication.",
"auth": {
"type": "noauth"
}
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": {\n \"message\": \"pong\"\n }\n }",
"name": "Successful Ping"
}
]
}
]
},
{
"name": "Authentication",
"description": "\nEndpoints for user authentication and token management.",
"item": [
{
"name": "Login & Token Creation",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/auth\/login",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/auth\/login"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"email\":\"test@example.com\",\"password\":\"secretPassword\",\"token_name\":\"my-data-script-token\",\"abilities\":[\"update\"]}"
},
"description": "Authenticates a user with email and password and returns an API token. Users who registered via OAuth (and\nhaven't set a password) cannot use this endpoint.",
"auth": {
"type": "noauth"
}
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": {\n \"token\": \"{YOUR_API_TOKEN}\"\n }\n }",
"name": "Successful Login"
},
{
"header": [],
"code": 401,
"body": "{\n \"success\": false,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Invalid credentials provided.\"\n }",
"name": "Invalid Credentials"
},
{
"header": [],
"code": 403,
"body": "{\n \"success\": false,\n \"code\": \"PASSWORD_LOGIN_UNAVAILABLE\",\n \"message\": \"Password login is not available for accounts created via OAuth. Please use the original login method or set a password for your account.\"\n }",
"name": "OAuth User Attempt"
},
{
"header": [],
"code": 422,
"body": "{\n \"success\": false,\n \"code\": \"VALIDATION_FAILED\",\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"email\": [ \"The email field is required.\" ],\n \"password\": [ \"The password field is required.\" ],\n \"abilities.0\": [ \"The selected ability read-invalid is invalid. Allowed abilities are: create, read, update, delete\" ]\n }\n }",
"name": "Validation Error"
}
]
},
{
"name": "Logout & Delete Current Token",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/auth\/logout",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/auth\/logout"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Revokes the specific API token that was used to make this request."
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": {\n \"message\": \"Current token revoked successfully.\"\n }\n }",
"name": "Successful Logout"
},
{
"header": [],
"code": 401,
"body": "{\n \"success\": false,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Unauthenticated.\"\n }",
"name": "Unauthenticated"
}
]
},
{
"name": "Logout & Delete All Tokens",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/auth\/logout\/all",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/auth\/logout\/all"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Revokes all API tokens associated with the authenticated user."
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": {\n \"message\": \"All tokens revoked successfully.\"\n }\n }",
"name": "Successful Logout All"
},
{
"header": [],
"code": 401,
"body": "{\n \"success\": false,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Unauthenticated.\"\n }",
"name": "Unauthenticated"
}
]
},
{
"name": "Registration",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/auth\/register",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/auth\/register"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"NewUser123\",\"email\":\"newuser@example.com\",\"password\":\"StrongP@ssw0rd!\",\"timezone\":\"America\\\/New_York\"}"
},
"description": "Creates a new user account. Email verification is still required.",
"auth": {
"type": "noauth"
}
},
"response": [
{
"header": [],
"code": 201,
"body": "{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"name\": \"NewUser123\",\n \"profile_photo_url\": \"https:\/\/ui-avatars.com\/api\/?name=NewUser123&color=...\",\n \"cover_photo_url\": \"https:\/\/picsum.photos\/seed\/NewUser123\/...\",\n \"timezone\": \"America\/New_York\",\n \"created_at\": \"2025-04-02T21:30:00.000000Z\",\n \"updated_at\": \"2025-04-01T10:00:00.000000Z\"\n }\n }",
"name": "Successful Registration"
},
{
"header": [],
"code": 422,
"body": "{\n \"success\": false,\n \"code\": \"VALIDATION_FAILED\",\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken.\"\n ],\n \"email\": [\n \"The email must be a valid email address.\"\n ],\n \"password\": [\n \"The password must be at least 8 characters.\"\n ],\n \"timezone\": [\n \"The timezone field is required.\"\n ]\n }\n }",
"name": "Validation Error"
}
]
},
{
"name": "Resend Email Verification",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/auth\/email\/resend",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/auth\/email\/resend"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"email\":\"unverified@example.com\"}"
},
"description": "Allows anyone to request a verification email resend by providing an email address. Use this if a user registered\nbut did not receive the initial email and cannot log in. For security, this endpoint always returns a success\nmessage, regardless of whether the email exists or is already verified, to prevent email enumeration.\n\nThis endpoint is heavily rate-limited.",
"auth": {
"type": "noauth"
}
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": {\n \"message\": \"If an account matching that email exists and requires verification, a new link has been sent.\"\n }\n }",
"name": "Request Accepted"
},
{
"header": [],
"code": 422,
"body": "{\n \"success\": false,\n \"code\": \"VALIDATION_FAILED\",\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"email\": [\n \"The email field is required.\"\n ]\n }\n }",
"name": "Validation Error"
}
]
},
{
"name": "Get Authenticated User",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/auth\/user",
"query": [
{
"key": "include",
"value": "role",
"description": "optional Comma-separated list of relationships to include. Available relationships: `role`.",
"disabled": false
}
],
"raw": "{{baseUrl}}\/api\/v0\/auth\/user?include=role"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Retrieves the details for the currently authenticated user based on the provided API token."
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"Test User\",\n \"email\": \"test@example.com\",\n \"email_verified_at\": \"2025-04-02T20:44:38.000000Z\",\n \"profile_photo_url\": \"https:\/\/example.com\/path\/to\/profile.jpg\",\n \"cover_photo_url\": \"https:\/\/example.com\/path\/to\/cover.jpg\",\n \"created_at\": \"2025-04-01T10:00:00.000000Z\"\n }\n }",
"name": "Success (No Includes)"
},
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"Test User\",\n \"email\": \"test@example.com\",\n \"email_verified_at\": \"2025-04-02T20:44:38.000000Z\",\n \"profile_photo_url\": \"https:\/\/example.com\/path\/to\/profile.jpg\",\n \"cover_photo_url\": \"https:\/\/example.com\/path\/to\/cover.jpg\",\n \"role\": {\n \"id\": 2,\n \"name\": \"Moderator\",\n \"short_name\": \"Mod\",\n \"description\": \"Moderate user content.\",\n \"color_class\": \"emerald\",\n },\n \"created_at\": \"2025-04-01T10:00:00.000000Z\",\n \"updated_at\": \"2025-04-01T10:00:00.000000Z\"\n }\n }",
"name": "Success (Include Role)"
},
{
"header": [],
"code": 401,
"body": "{\n \"success\": false,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Unauthenticated.\"\n }",
"name": "Unauthenticated"
}
]
},
{
"name": "Token Abilities",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/auth\/abilities",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/auth\/abilities"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get the current token's abilities."
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n \"success\": true,\n \"data\": [\n \"read\",\n \"create\",\n \"update\",\n \"delete\"\n ]\n}",
"name": "Success"
},
{
"header": [],
"code": 401,
"body": "{\n \"success\": false,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Unauthenticated.\"\n}",
"name": "Unauthenticated"
}
]
}
]
},
{
"name": "Mods",
"description": "\nEndpoints for managing and retrieving mods.",
"item": [
{
"name": "Get Mods",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "api\/v0\/mods",
"query": [],
"raw": "{{baseUrl}}\/api\/v0\/mods",
"variable": [
{
"id": "fields",
"key": "fields",
"value": "name%2Cslug%2Cfeatured%2Ccreated_at",
"description": "Comma-separated list of fields to include in the response. Defaults to all fields."
},
{
"id": "filter[id]",
"key": "filter[id]",
"value": "1%2C5%2C10",
"description": "Filter by comma-separated Mod IDs."
},
{
"id": "filter[hub_id]",
"key": "filter[hub_id]",
"value": "123%2C456",
"description": "Filter by comma-separated Hub IDs."
},
{
"id": "filter[guid]",
"key": "filter[guid]",
"value": "com.example.mymod1%2Ccom.example.mymod2",
"description": "Filter by comma-separated GUIDs."
},
{
"id": "filter[name]",
"key": "filter[name]",
"value": "Raid+Time",
"description": "Filter by name (fuzzy filter)."
},
{
"id": "filter[slug]",
"key": "filter[slug]",
"value": "some-mod",
"description": "Filter by slug (fuzzy filter)."
},
{
"id": "filter[teaser]",
"key": "filter[teaser]",
"value": "important",
"description": "Filter by teaser text (fuzzy filter)."
},
{
"id": "filter[featured]",
"key": "filter[featured]",
"value": "true",
"description": "Filter by featured status (1, true, 0, false)."
},
{
"id": "filter[contains_ads]",
"key": "filter[contains_ads]",
"value": "false",
"description": "Filter by contains_ads status (1, true, 0, false)."
},
{
"id": "filter[contains_ai_content]",
"key": "filter[contains_ai_content]",
"value": "false",
"description": "Filter by contains_ai_content status (1, true, 0, false)."
},
{
"id": "filter[category_id]",
"key": "filter[category_id]",
"value": "1%2C2%2C3",
"description": "Filter by comma-separated category IDs."
},
{
"id": "filter[category_slug]",
"key": "filter[category_slug]",
"value": "weapons%2Cgear",
"description": "Filter by comma-separated category slugs."
},
{
"id": "filter[created_between]",
"key": "filter[created_between]",
"value": "2025-01-01%2C2025-03-31",
"description": "Filter by creation date range (YYYY-MM-DD,YYYY-MM-DD)."
},
{
"id": "filter[updated_between]",
"key": "filter[updated_between]",
"value": "2025-01-01%2C2025-03-31",
"description": "Filter by update date range (YYYY-MM-DD,YYYY-MM-DD)."
},
{
"id": "filter[published_between]",
"key": "filter[published_between]",
"value": "2025-01-01%2C2025-03-31",
"description": "Filter by publication date range (YYYY-MM-DD,YYYY-MM-DD)."
},
{
"id": "filter[spt_version]",
"key": "filter[spt_version]",
"value": "%5E3.8.0",
"description": "Filter mods that are compatible with an SPT version SemVer constraint. This will only filter the mods, not the mod versions."
},
{
"id": "filter[fika_compatibility]",
"key": "filter[fika_compatibility]",
"value": "true",
"description": "Filter by Fika compatibility status. When true, only shows mods with Fika compatible versions (1, true, 0, false)."
},
{
"id": "filter[include_legacy]",
"key": "filter[include_legacy]",
"value": "true",
"description": "Include legacy mods (mods with versions that have no SPT version constraint). By default, legacy mods are excluded from results (1, true, 0, false)."
},
{
"id": "query",
"key": "query",
"value": "raid+time",
"description": "Search query to filter mods using Meilisearch. This will search across name, slug, and description fields."
},
{
"id": "include",
"key": "include",
"value": "versions%2Ccategory",
"description": "Comma-separated list of relationships. Available: `versions`, `license`, `category`, `source_code_links`."
},
{
"id": "sort",
"key": "sort",
"value": "featured%2C-name",
"description": "Sort results by attribute(s). Default ASC. Prefix with `-` for DESC. Comma-separate multiple fields. Allowed: `name`, `featured`, `created_at`, `updated_at`, `published_at`."
},
{
"id": "page",
"key": "page",
"value": "2",
"description": "The page number for pagination."
},
{
"id": "per_page",
"key": "per_page",
"value": "25",
"description": "The number of results per page (max 50)."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Retrieves a paginated list of mods, allowing filtering, sorting, and relationship inclusion.\n\nFields available:
hub_id, guid, name, slug, teaser, thumbnail, downloads, detail_url,\nfika_compatibility, featured, contains_ai_content, contains_ads, shows_profile_binding_notice, category_id,\npublished_at, created_at, updated_at<\/code>\n\n