string JobId

{
  "type": "string",
  "example": "1372966999991541762",
  "pattern": "^[0-9]{1,19}$",
  "description": "Compliance Job ID."
}

object List

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/ListId"
    },
    "name": {
      "type": "string",
      "description": "The name of this List."
    },
    "private": {
      "type": "boolean"
    },
    "owner_id": {
      "$ref": "#/components/schemas/UserId"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string"
    },
    "member_count": {
      "type": "integer"
    },
    "follower_count": {
      "type": "integer"
    }
  },
  "description": "A Twitter List is a curated group of accounts."
}

object ListAddUserRequest

{
  "type": "object",
  "required": [
    "user_id"
  ],
  "properties": {
    "user_id": {
      "$ref": "#/components/schemas/UserId"
    }
  }
}

object ListCreateRequest

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 25,
      "minLength": 1
    },
    "private": {
      "type": "boolean",
      "default": false
    },
    "description": {
      "type": "string",
      "maxLength": 100,
      "minLength": 0
    }
  }
}

object ListCreateResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "$ref": "#/components/schemas/ListId"
        },
        "name": {
          "type": "string",
          "description": "The name of this List."
        }
      },
      "description": "A Twitter List is a curated group of accounts."
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

object ListDeleteResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "deleted": {
          "type": "boolean"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

object ListFollowedRequest

{
  "type": "object",
  "required": [
    "list_id"
  ],
  "properties": {
    "list_id": {
      "$ref": "#/components/schemas/ListId"
    }
  }
}

object ListFollowedResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "following": {
          "type": "boolean"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

string ListId

{
  "type": "string",
  "example": "1146654567674912769",
  "pattern": "^[0-9]{1,19}$",
  "description": "The unique identifier of this List."
}

object ListMutateResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "is_member": {
          "type": "boolean"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

object ListPinnedRequest

{
  "type": "object",
  "required": [
    "list_id"
  ],
  "properties": {
    "list_id": {
      "$ref": "#/components/schemas/ListId"
    }
  }
}

object ListPinnedResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "pinned": {
          "type": "boolean"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

object ListUnpinResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "pinned": {
          "type": "boolean"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

object ListUpdateRequest

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 25,
      "minLength": 1
    },
    "private": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "maxLength": 100,
      "minLength": 0
    }
  }
}

object ListUpdateResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "updated": {
          "type": "boolean"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

object Media

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "width": {
      "$ref": "#/components/schemas/MediaWidth"
    },
    "height": {
      "$ref": "#/components/schemas/MediaHeight"
    },
    "media_key": {
      "$ref": "#/components/schemas/MediaKey"
    }
  },
  "discriminator": {
    "mapping": {
      "photo": "#/components/schemas/Photo",
      "video": "#/components/schemas/Video",
      "animated_gif": "#/components/schemas/AnimatedGif"
    },
    "propertyName": "type"
  }
}

integer MediaHeight

{
  "type": "integer",
  "minimum": 0,
  "description": "The height of the media in pixels."
}

string MediaId

{
  "type": "string",
  "example": "1146654567674912769",
  "pattern": "^[0-9]{1,19}$",
  "description": "The unique identifier of this Media."
}

string MediaKey

{
  "type": "string",
  "pattern": "^([0-9]+)_([0-9]+)$",
  "description": "The Media Key identifier for this attachment."
}

integer MediaWidth

{
  "type": "integer",
  "minimum": 0,
  "description": "The width of the media in pixels."
}

object MentionEntity

{
  "allOf": [
    {
      "$ref": "#/components/schemas/EntityIndicesInclusiveExclusive"
    },
    {
      "$ref": "#/components/schemas/MentionFields"
    }
  ]
}

object MentionFields

{
  "type": "object",
  "required": [
    "username"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UserId"
    },
    "username": {
      "$ref": "#/components/schemas/UserName"
    }
  },
  "description": "Represent the portion of text recognized as a User mention, and its start and end position within the text."
}

object MuteUserMutationResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "muting": {
          "type": "boolean"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Problem"
      },
      "minItems": 1
    }
  }
}

object MuteUserRequest

{
  "type": "object",
  "required": [
    "target_user_id"
  ],
  "properties": {
    "target_user_id": {
      "$ref": "#/components/schemas/UserId"
    }
  }
}

string NewestId

{
  "type": "string",
  "description": "The newest id in this response."
}

string NextToken

{
  "type": "string",
  "minLength": 1,
  "description": "The next token."
}

string OldestId

{
  "type": "string",
  "description": "The oldest id in this response."
}

object OperationalDisconnectProblem

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem"
    },
    {
      "type": "object",
      "properties": {
        "disconnect_type": {
          "enum": [
            "OperationalDisconnect",
            "UpstreamOperationalDisconnect",
            "ForceDisconnect",
            "UpstreamUncleanDisconnect",
            "SlowReader",
            "InternalError",
            "ClientApplicationStateDegraded",
            "InvalidRules"
          ],
          "type": "string"
        }
      }
    }
  ],
  "description": "You have been disconnected for operational reasons."
}

string PaginationToken32

{
  "type": "string",
  "minLength": 16,
  "description": "A base32 pagination token."
}

string PaginationToken36

{
  "type": "string",
  "minLength": 1,
  "description": "A base36 pagination token."
}

string PaginationTokenLong

{
  "type": "string",
  "maxLength": 19,
  "minLength": 1,
  "description": "A 'long' pagination token."
}

object Photo

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Media"
    },
    {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "format": "uri"
        },
        "alt_text": {
          "type": "string"
        }
      }
    }
  ]
}

object Place

{
  "type": "object",
  "required": [
    "id",
    "full_name"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/PlaceId"
    },
    "geo": {
      "$ref": "#/components/schemas/Geo"
    },
    "name": {
      "type": "string",
      "example": "Lakewood",
      "description": "The human readable name of this place."
    },
    "country": {
      "type": "string",
      "example": "United States",
      "description": "The full name of the county in which this place exists."
    },
    "full_name": {
      "type": "string",
      "example": "Lakewood, CO",
      "description": "The full name of this place."
    },
    "place_type": {
      "$ref": "#/components/schemas/PlaceType"
    },
    "country_code": {
      "$ref": "#/components/schemas/CountryCode"
    },
    "contained_within": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PlaceId"
      },
      "minItems": 1
    }
  }
}

string PlaceId

{
  "type": "string",
  "example": "f7eb2fa2fea288b1",
  "description": "The identifier for this place."
}

string PlaceType

{
  "enum": [
    "poi",
    "neighborhood",
    "city",
    "admin",
    "country",
    "unknown"
  ],
  "type": "string",
  "example": "city"
}

object Point

{
  "type": "object",
  "required": [
    "type",
    "coordinates"
  ],
  "properties": {
    "type": {
      "enum": [
        "Point"
      ],
      "type": "string",
      "example": "Point"
    },
    "coordinates": {
      "$ref": "#/components/schemas/Position"
    }
  },
  "description": "A [GeoJson Point](https://tools.ietf.org/html/rfc7946#section-3.1.2) geometry object."
}

object Poll

{
  "type": "object",
  "required": [
    "id",
    "options"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/PollId"
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PollOption"
      },
      "maxItems": 4,
      "minItems": 2
    },
    "end_datetime": {
      "type": "string",
      "format": "date-time"
    },
    "voting_status": {
      "enum": [
        "open",
        "closed"
      ],
      "type": "string"
    },
    "duration_minutes": {
      "type": "integer",
      "format": "int32",
      "maximum": 10080,
      "minimum": 5
    }
  },
  "description": "Represent a Poll attached to a Tweet."
}

string PollId

{
  "type": "string",
  "example": "1365059861688410112",
  "pattern": "^[0-9]{1,19}$",
  "description": "Unique identifier of this poll."
}

object PollOption

{
  "type": "object",
  "required": [
    "position",
    "label",
    "votes"
  ],
  "properties": {
    "label": {
      "$ref": "#/components/schemas/PollOptionLabel"
    },
    "votes": {
      "type": "integer",
      "description": "Number of users who voted for this choice."
    },
    "position": {
      "type": "integer",
      "description": "Position of this choice in the poll."
    }
  },
  "description": "Describes a choice in a Poll object."
}

string PollOptionLabel

{
  "type": "string",
  "maxLength": 25,
  "minLength": 1,
  "description": "The text of a poll choice."
}

array Position

{
  "type": "array",
  "items": {
    "type": "number"
  },
  "example": [
    -105.18816086351444,
    40.247749999999996
  ],
  "maxItems": 2,
  "minItems": 2,
  "description": "A [GeoJson Position](https://tools.ietf.org/html/rfc7946#section-3.1.1) in the format `[longitude,latitude]`."
}

string PreviousToken

{
  "type": "string",
  "minLength": 1,
  "description": "The previous token."
}

object Problem

{
  "type": "object",
  "required": [
    "type",
    "title"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    }
  },
  "description": "An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).",
  "discriminator": {
    "mapping": {
      "about:blank": "#/components/schemas/GenericProblem",
      "https://api.twitter.com/2/problems/conflict": "#/components/schemas/ConflictProblem",
      "https://api.twitter.com/2/problems/rule-cap": "#/components/schemas/RulesCapProblem",
      "https://api.twitter.com/2/problems/usage-capped": "#/components/schemas/UsageCapExceededProblem",
      "https://api.twitter.com/2/problems/invalid-rules": "#/components/schemas/InvalidRuleProblem",
      "https://api.twitter.com/2/problems/duplicate-rules": "#/components/schemas/DuplicateRuleProblem",
      "https://api.twitter.com/2/problems/invalid-request": "#/components/schemas/InvalidRequestProblem",
      "https://api.twitter.com/2/problems/client-forbidden": "#/components/schemas/ClientForbiddenProblem",
      "https://api.twitter.com/2/problems/noncompliant-rules": "#/components/schemas/NonCompliantRulesProblem",
      "https://api.twitter.com/2/problems/oauth1-permissions": "#/components/schemas/Oauth1PermissionsProblem",
      "https://api.twitter.com/2/problems/resource-not-found": "#/components/schemas/ResourceNotFoundProblem",
      "https://api.twitter.com/2/problems/client-disconnected": "#/components/schemas/ClientDisconnectedProblem",
      "https://api.twitter.com/2/problems/disallowed-resource": "#/components/schemas/DisallowedResourceProblem",
      "https://api.twitter.com/2/problems/resource-unavailable": "#/components/schemas/ResourceUnavailableProblem",
      "https://api.twitter.com/2/problems/streaming-connection": "#/components/schemas/ConnectionExceptionProblem",
      "https://api.twitter.com/2/problems/operational-disconnect": "#/components/schemas/OperationalDisconnectProblem",
      "https://api.twitter.com/2/problems/not-authorized-for-field": "#/components/schemas/FieldUnauthorizedProblem",
      "https://api.twitter.com/2/problems/unsupported-authentication": "#/components/schemas/UnsupportedAuthenticationProblem",
      "https://api.twitter.com/2/problems/not-authorized-for-resource": "#/components/schemas/ResourceUnauthorizedProblem"
    },
    "propertyName": "type"
  }
}

string ReplySettings

{
  "enum": [
    "everyone",
    "mentionedUsers",
    "following",
    "other"
  ],
  "type": "string",
  "pattern": "^[A-Za-z]{1,12}$",
  "description": "Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, and following."
}

object ResourceNotFoundProblem

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem"
    },
    {
      "type": "object",
      "required": [
        "parameter",
        "value",
        "resource_id",
        "resource_type"
      ],
      "properties": {
        "value": {
          "type": "string",
          "description": "Value will match the schema of the field."
        },
        "parameter": {
          "type": "string",
          "minLength": 1
        },
        "resource_id": {
          "type": "string"
        },
        "resource_type": {
          "enum": [
            "user",
            "tweet",
            "media",
            "list",
            "space"
          ],
          "type": "string"
        }
      }
    }
  ],
  "description": "A problem that indicates that a given Tweet, User, etc. does not exist."
}

object ResourceUnauthorizedProblem

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem"
    },
    {
      "type": "object",
      "required": [
        "value",
        "resource_id",
        "resource_type",
        "section",
        "parameter"
      ],
      "properties": {
        "value": {
          "type": "string"
        },
        "section": {
          "enum": [
            "data",
            "includes"
          ],
          "type": "string"
        },
        "parameter": {
          "type": "string"
        },
        "resource_id": {
          "type": "string"
        },
        "resource_type": {
          "enum": [
            "user",
            "tweet",
            "media",
            "list",
            "space"
          ],
          "type": "string"
        }
      }
    }
  ],
  "description": "A problem that indicates you are not allowed to see a particular Tweet, User, etc."
}

object ResourceUnavailableProblem

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem"
    },
    {
      "type": "object",
      "required": [
        "parameter",
        "resource_id",
        "resource_type"
      ],
      "properties": {
        "parameter": {
          "type": "string",
          "minLength": 1
        },
        "resource_id": {
          "type": "string"
        },
        "resource_type": {
          "enum": [
            "user",
            "tweet",
            "media",
            "list",
            "space"
          ],
          "type": "string"
        }
      }
    }
  ],
  "description": "A problem that indicates a particular Tweet, User, etc. is not available to you."
}

integer ResultCount

{
  "type": "integer",
  "format": "int32",
  "description": "The number of results returned in this response."
}

object Rule

{
  "type": "object",
  "required": [
    "value"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/RuleId"
    },
    "tag": {
      "$ref": "#/components/schemas/RuleTag"
    },
    "value": {
      "$ref": "#/components/schemas/RuleValue"
    }
  },
  "description": "A user-provided stream filtering rule."
}

string RuleId

{
  "type": "string",
  "example": "120897978112909812",
  "pattern": "^[0-9]{1,19}$",
  "description": "Unique identifier of this rule."
}