TokenResponse

Response returned by /api_token.php — request or reset a session token.

TriviaGames And ComicsQuizOpen DataPublic APIsOpen Source

Properties

Name	Type	Description
response_code	integer	Outcome code: 0 success, 3 token not found, 4 token empty.
response_message	string	Human-readable description of the response code.
token	string	The session token. Present on command=request and on a successful command=reset call.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/open-trivia/refs/heads/main/json-schema/open-trivia-token-response-schema.json",
  "title": "TokenResponse",
  "description": "Response returned by /api_token.php — request or reset a session token.",
  "type": "object",
  "required": ["response_code"],
  "properties": {
    "response_code": {
      "type": "integer",
      "description": "Outcome code: 0 success, 3 token not found, 4 token empty.",
      "enum": [0, 1, 2, 3, 4, 5],
      "example": 0
    },
    "response_message": {
      "type": "string",
      "description": "Human-readable description of the response code.",
      "example": "Token Generated Successfully!"
    },
    "token": {
      "type": "string",
      "description": "The session token. Present on command=request and on a successful command=reset call.",
      "example": "5b76e266e1955dc8c216be34a8280d1f8e2d9f82d3d93a755f772d2537e14b25"
    }
  }
}