Home Docs GET Retrieve Forms

Retrieve Forms

Get all available forms for your game.

GET
/ api/sdk/forms

Headers

X-API-Key
string required

Your game's API key for authentication. You can find this in your game settings on the dashboard.

Request

curl -X GET "https://indieop.com/api/sdk/forms" \
  -H "X-API-Key: your_game_api_key_here"

Response

{
  "success": true,
  "data": {
    "forms": [
      {
        "name": "Player Feedback",
        "tag": "feedback",
        "fields": [
          {
            "field_key": "rating",
            "label": "Overall Rating",
            "field_type": "rating",
            "options": null
          },
          {
            "field_key": "comments",
            "label": "Additional Comments",
            "field_type": "text",
            "options": null
          },
          {
            "field_key": "difficulty",
            "label": "Difficulty Level",
            "field_type": "dropdown",
            "options": ["Easy", "Medium", "Hard"]
          }
        ]
      }
    ]
  }
}

Response Schema

success
boolean

Indicates if the request was successful.

data
object

Container object for the response data.

Show nested properties
forms
array

Array of form objects.

name
string

The display name of the form.

tag
string

Unique identifier for the form. Use this when submitting form data.

fields
array

Array of field objects for this form.

field_key
string

Unique identifier for the field.

label
string

Display label for the field.

field_type
string

Type of field. Possible values:

  • text - Free-form text input
  • dropdown - Select from options
  • checkbox - Boolean value
  • rating - Numeric rating (1-5)
options
array nullable

Available options for dropdown fields. null for other field types.

Error Responses

401 Unauthorized

Missing or invalid API key. Verify your X-API-Key header is correct.

404 Not Found

Game not found or inactive. Verify your game exists and is active in the dashboard.

429 Too Many Requests

Rate limit exceeded (100 requests per minute). Wait before retrying.

500 Internal Server Error

Something went wrong. Try again or contact support if the issue persists.

See Error Codes for detailed information about all possible errors.