RankGun logoRankGun
API ReferenceApplication Centre

List Application Forms

List every application form in your workspace (summary fields only).

GET /api/applications

Returns every application form in the workspace identified by your API key, with summary fields only — no questions, no answer keys. Use GET /api/applications/forms/{formId} to fetch the full form including its questions.

The workspace is inferred from the API key — there is no path, query, or body parameter to specify it.

Application Centre is not Elite-gated. Free-tier workspaces succeed here just like Elite-tier workspaces.

Headers

Prop

Type

curl https://api.rankgun.works/api/applications \
  -H "x-api-key: YOUR_API_KEY"

Response

200 OK

{
  "workspace": {
    "id": "ms78tzxrfqjkd371eewp3dcp9s7z28st",
    "groupId": 12345678,
    "tier": "elite"
  },
  "forms": [
    {
      "id": "j97a6m1abc123def456ghi789jkl012",
      "name": "Tier 1 Quiz",
      "description": "Entry-level rank application.",
      "isActive": true,
      "targetRankId": 5,
      "targetRankName": "Junior Member",
      "passPercentage": 70,
      "cooldownHours": 24,
      "maxSubmissions": null,
      "questionCount": 8,
      "createdAt": 1700000000,
      "updatedAt": 1710000000
    }
  ]
}

Top-level fields

Prop

Type

workspace object

Prop

Type

Form object (summary)

Prop

Type

Empty workspace

{
  "workspace": {
    "id": "ms78tzxrfqjkd371eewp3dcp9s7z28st",
    "groupId": 12345678,
    "tier": "free"
  },
  "forms": []
}

Errors

Every error response has the shape:

{ "success": false, "code": "MACHINE_CODE", "error": "Human message" }

code is stable across versions and is what you should branch on. error is human-readable and may change wording.

401 MISSING_API_KEY

No x-api-key (or Authorization: Bearer / api_token) header was sent.

{
  "success": false,
  "code": "MISSING_API_KEY",
  "error": "Provide an API key via the x-api-key header."
}

403 INVALID_API_KEY

The key was provided but is not recognised. Most commonly: the workspace owner regenerated the key, or the key was never minted.

{
  "success": false,
  "code": "INVALID_API_KEY",
  "error": "API key is invalid or has been regenerated."
}

403 WORKSPACE_DEACTIVATED

The key matches a workspace, but the workspace has been deactivated by an admin and cannot make API calls.

{
  "success": false,
  "code": "WORKSPACE_DEACTIVATED",
  "error": "This workspace has been deactivated. Contact [email protected]."
}

500 INTERNAL_ERROR

Unhandled server error. Safe to retry with exponential backoff.

{
  "success": false,
  "code": "INTERNAL_ERROR",
  "error": "An unexpected error occurred. Try again or contact support."
}
Was this page helpful?

On this page