X (Twitter) · Schema

User

The X User object.

Social MediaMicrobloggingReal-Time DataStreamingAdvertisingContent

Properties

Name	Type	Description
affiliation	object	Metadata about a user's affiliation.
connection_status	array	Returns detailed information about the relationship between two users.
created_at	string	Creation time of this User.
description	string	The text of this User's profile description (also known as bio), if the User provided one.
entities	object	A list of metadata found in the User's profile description.
id	string	Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
location	string	The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with
most_recent_tweet_id	string	Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
name	string	The friendly name of this User, as shown on their profile.
pinned_tweet_id	string	Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
profile_banner_url	string	The URL to the profile banner for this User.
profile_image_url	string	The URL to the profile image for this User.
protected	boolean	Indicates if this User has chosen to protect their Posts (in other words, if this User's Posts are private).
public_metrics	object	A list of metrics for this User.
receives_your_dm	boolean	Indicates if you can send a DM to this User
subscription_type	string	The X Blue subscription type of the user, eg: Basic, Premium, PremiumPlus or None.
url	string	The URL specified in the User's profile.
username	string	The X handle (screen name) of this user.
verified	boolean	Indicate if this User is a verified X User.
verified_type	string	The X Blue verified type of the user, eg: blue, government, business or none.
withheld	object	Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twitter/refs/heads/main/json-schema/x-api-user-schema.json",
  "title": "User",
  "description": "The X User object.",
  "type": "object",
  "properties": {
    "affiliation": {
      "type": "object",
      "description": "Metadata about a user's affiliation.",
      "properties": {
        "badge_url": {
          "type": "string",
          "description": "The badge URL corresponding to the affiliation.",
          "format": "uri"
        },
        "description": {
          "type": "string",
          "description": "The description of the affiliation."
        },
        "url": {
          "type": "string",
          "description": "The URL, if available, to details about an affiliation.",
          "format": "uri"
        },
        "user_id": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "#/components/schemas/UserId"
          }
        }
      }
    },
    "connection_status": {
      "type": "array",
      "description": "Returns detailed information about the relationship between two users.",
      "minItems": 0,
      "items": {
        "type": "string",
        "description": "Type of connection between users.",
        "enum": [
          "follow_request_received",
          "follow_request_sent",
          "blocking",
          "followed_by",
          "following",
          "muting"
        ]
      }
    },
    "created_at": {
      "type": "string",
      "description": "Creation time of this User.",
      "format": "date-time"
    },
    "description": {
      "type": "string",
      "description": "The text of this User's profile description (also known as bio), if the User provided one."
    },
    "entities": {
      "type": "object",
      "description": "A list of metadata found in the User's profile description.",
      "properties": {
        "description": {
          "$ref": "#/components/schemas/FullTextEntities"
        },
        "url": {
          "type": "object",
          "description": "Expanded details for the URL specified in the User's profile, with start and end indices.",
          "properties": {
            "urls": {
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/components/schemas/UrlEntity"
              }
            }
          }
        }
      }
    },
    "id": {
      "type": "string",
      "description": "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.",
      "pattern": "^[0-9]{1,19}$",
      "example": "2244994945"
    },
    "location": {
      "type": "string",
      "description": "The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries."
    },
    "most_recent_tweet_id": {
      "type": "string",
      "description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.",
      "pattern": "^[0-9]{1,19}$",
      "example": "1346889436626259968"
    },
    "name": {
      "type": "string",
      "description": "The friendly name of this User, as shown on their profile."
    },
    "pinned_tweet_id": {
      "type": "string",
      "description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.",
      "pattern": "^[0-9]{1,19}$",
      "example": "1346889436626259968"
    },
    "profile_banner_url": {
      "type": "string",
      "description": "The URL to the profile banner for this User.",
      "format": "uri"
    },
    "profile_image_url": {
      "type": "string",
      "description": "The URL to the profile image for this User.",
      "format": "uri"
    },
    "protected": {
      "type": "boolean",
      "description": "Indicates if this User has chosen to protect their Posts (in other words, if this User's Posts are private)."
    },
    "public_metrics": {
      "type": "object",
      "description": "A list of metrics for this User.",
      "required": [
        "followers_count",
        "following_count",
        "tweet_count",
        "listed_count"
      ],
      "properties": {
        "followers_count": {
          "type": "integer",
          "description": "Number of Users who are following this User."
        },
        "following_count": {
          "type": "integer",
          "description": "Number of Users this User is following."
        },
        "like_count": {
          "type": "integer",
          "description": "The number of likes created by this User."
        },
        "listed_count": {
          "type": "integer",
          "description": "The number of lists that include this User."
        },
        "tweet_count": {
          "type": "integer",
          "description": "The number of Posts (including Retweets) posted by this User."
        }
      }
    },
    "receives_your_dm": {
      "type": "boolean",
      "description": "Indicates if you can send a DM to this User"
    },
    "subscription_type": {
      "type": "string",
      "description": "The X Blue subscription type of the user, eg: Basic, Premium, PremiumPlus or None.",
      "enum": [
        "Basic",
        "Premium",
        "PremiumPlus",
        "None"
      ]
    },
    "url": {
      "type": "string",
      "description": "The URL specified in the User's profile."
    },
    "username": {
      "type": "string",
      "description": "The X handle (screen name) of this user.",
      "pattern": "^[A-Za-z0-9_]{1,15}$"
    },
    "verified": {
      "type": "boolean",
      "description": "Indicate if this User is a verified X User."
    },
    "verified_type": {
      "type": "string",
      "description": "The X Blue verified type of the user, eg: blue, government, business or none.",
      "enum": [
        "blue",
        "government",
        "business",
        "none"
      ]
    },
    "withheld": {
      "type": "object",
      "description": "Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).",
      "required": [
        "country_codes"
      ],
      "properties": {
        "country_codes": {
          "type": "array",
          "description": "Provides a list of countries where this content is not available.",
          "minItems": 1,
          "uniqueItems": true,
          "items": {
            "$ref": "#/components/schemas/CountryCode"
          }
        },
        "scope": {
          "type": "string",
          "description": "Indicates that the content being withheld is a `user`.",
          "enum": [
            "user"
          ]
        }
      }
    }
  },
  "required": [
    "id",
    "name",
    "username"
  ]
}