JokeAPI · Schema

EndpointsResponse

Endpoint catalogue envelope.

JokesHumorEntertainmentOpen SourceREST APIGames And ComicsPublic APIs

Properties

Name Type Description
error boolean
endpoints array
timestamp integer
View JSON Schema on GitHub

JSON Schema

jokeapi-endpoints-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/jokeapi/refs/heads/main/json-schema/jokeapi-endpoints-response-schema.json",
  "title": "EndpointsResponse",
  "description": "Endpoint catalogue envelope.",
  "type": "object",
  "properties": {
    "error": {
      "type": "boolean",
      "example": false
    },
    "endpoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Joke"
          },
          "usage": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string",
                "example": "GET"
              },
              "url": {
                "type": "string",
                "example": "https://v2.jokeapi.dev/joke/{category}"
              },
              "supportedParams": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "format",
                  "blacklistFlags",
                  "type",
                  "contains",
                  "idRange",
                  "amount",
                  "lang",
                  "safe-mode"
                ]
              }
            }
          }
        }
      }
    },
    "timestamp": {
      "type": "integer",
      "example": 1780051223357
    }
  },
  "required": [
    "error",
    "endpoints",
    "timestamp"
  ]
}