JokeAPI · Schema

FlagsResponse

Blacklist flags metadata envelope.

JokesHumorEntertainmentOpen SourceREST APIGames And ComicsPublic APIs

Properties

Name Type Description
error boolean
flags array Flags consumers can pass to `?blacklistFlags`.
timestamp integer
View JSON Schema on GitHub

JSON Schema

jokeapi-flags-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-flags-response-schema.json",
  "title": "FlagsResponse",
  "description": "Blacklist flags metadata envelope.",
  "type": "object",
  "properties": {
    "error": {
      "type": "boolean",
      "example": false
    },
    "flags": {
      "type": "array",
      "description": "Flags consumers can pass to `?blacklistFlags`.",
      "items": {
        "type": "string"
      },
      "example": [
        "nsfw",
        "religious",
        "political",
        "racist",
        "sexist",
        "explicit"
      ]
    },
    "timestamp": {
      "type": "integer",
      "example": 1780051223357
    }
  },
  "required": [
    "error",
    "flags",
    "timestamp"
  ]
}