Path parameters

• id string Required

  The ID of the user for whom to return results

Query parameters

• max_results integer(int32)

  The maximum number of results

  Minimum value is 1, maximum value is 1000.

• pagination_token string

  This value is populated by passing the 'next_token' or 'previous_token' returned in a request to paginate through results.

Responses

• 200

  The request was successful

  Hide response attributes Show response attributes object

  • data array[object]

    The Twitter User object

    Hide data attributes Show data attributes array[object]

    • id string Required

      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.

      Format should match the following pattern: ^[0-9]{1,19}$.

    • created_at string(date-time)

      Creation time of this user.

    • name string Required

      The friendly name of this user, as shown on their profile.

    • username string Required

      The Twitter handle (screen name) of this user.

      Format should match the following pattern: ^[A-Za-z0-9_]{1,15}$.

    • protected boolean

      Indicates if this user has chosen to protect their Tweets (in other words, if this user's Tweets are private).

    • verified boolean

      Indicate if this user is a verified Twitter User.

    • withheld object

      Indicates withholding details for withheld content.

      Hide withheld attributes Show withheld attributes object

      • country_codes array[string] Required

        A two-letter ISO 3166-1 alpha-2 country code

        At least 1 element. Format of each should match the following pattern: ^[A-Z]{2}$.

      • scope string

        Indicates that the content being withheld is a user.

        Value is user.

    • profile_image_url string(uri)

      The URL to the profile image for this user.

    • 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 location queries.

    • url string

      The URL specified in the user's profile.

    • 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.

      Hide entities attributes Show entities attributes object

      • url object

        Expanded details for the URL specified in the user's profile, with start and end indices.

        Hide url attribute Show url attribute object

        • urls array[object]

          Represent the portion of text recognized as a URL.

          At least 1 element.

          Hide urls attributes Show urls attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • url string(uri) Required

            A validly formatted URL.

          • expanded_url string(uri)

            A validly formatted URL.

          • display_url string

            The URL as displayed in the Twitter client.

          • unwound_url string(uri)

            Fully resolved url

          • status integer

            HTTP Status Code.

            Minimum value is 100, maximum value is 599.

          • title string

            Title of the page the URL points to.

          • description string

            Description of the URL landing page.

          • images array[object]

            Represent the information for the URL image

            At least 1 element.

            Hide images attributes Show images attributes array[object]

            • url string(uri)

              A validly formatted URL.

            • height integer

              The height of the media in pixels

              Minimum value is 0.

            • width integer

              The width of the media in pixels

              Minimum value is 0.

      • description object
        Hide description attributes Show description attributes object

        • urls array[object]

          Represent the portion of text recognized as a URL.

          At least 1 element.

          Hide urls attributes Show urls attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • url string(uri) Required

            A validly formatted URL.

          • expanded_url string(uri)

            A validly formatted URL.

          • display_url string

            The URL as displayed in the Twitter client.

          • unwound_url string(uri)

            Fully resolved url

          • status integer

            HTTP Status Code.

            Minimum value is 100, maximum value is 599.

          • title string

            Title of the page the URL points to.

          • description string

            Description of the URL landing page.

          • images array[object]

            Represent the information for the URL image

            At least 1 element.

            Hide images attributes Show images attributes array[object]

            • url string(uri)

              A validly formatted URL.

            • height integer

              The height of the media in pixels

              Minimum value is 0.

            • width integer

              The width of the media in pixels

              Minimum value is 0.

        • hashtags array[object]

          Represent the portion of text recognized as a Hashtag, and its start and end position within the text.

          At least 1 element.

          Hide hashtags attributes Show hashtags attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • tag string Required

            The text of the Hashtag

        • mentions array[object]

          Represent the portion of text recognized as a User mention, and its start and end position within the text.

          At least 1 element.

          Hide mentions attributes Show mentions attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • username string Required

            The Twitter handle (screen name) of this user.

            Format should match the following pattern: ^[A-Za-z0-9_]{1,15}$.

          • id string Required

            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.

            Format should match the following pattern: ^[0-9]{1,19}$.

        • cashtags array[object]

          Represent the portion of text recognized as a Cashtag, and its start and end position within the text.

          At least 1 element.

          Hide cashtags attributes Show cashtags attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • tag string Required
    • 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.

      Format should match the following pattern: ^[0-9]{1,19}$.

    • public_metrics object

      A list of metrics for this user

      Hide public_metrics attributes Show public_metrics attributes object

      • followers_count integer Required

        Number of users who are following this user.

      • following_count integer Required

        Number of users this user is following.

      • tweet_count integer Required

        The number of Tweets (including Retweets) posted by this user.

      • listed_count integer Required

        The number of lists that include this user.

  • includes object
    Hide includes attributes Show includes attributes object

    • users array[object]

      The Twitter User object

      At least 1 element.

      Hide users attributes Show users attributes array[object]

      • id string Required

        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.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • created_at string(date-time)

        Creation time of this user.

      • name string Required

        The friendly name of this user, as shown on their profile.

      • username string Required

        The Twitter handle (screen name) of this user.

        Format should match the following pattern: ^[A-Za-z0-9_]{1,15}$.

      • protected boolean

        Indicates if this user has chosen to protect their Tweets (in other words, if this user's Tweets are private).

      • verified boolean

        Indicate if this user is a verified Twitter User.

      • withheld object

        Indicates withholding details for withheld content.

        Hide withheld attributes Show withheld attributes object

        • country_codes array[string] Required

          A two-letter ISO 3166-1 alpha-2 country code

          At least 1 element. Format of each should match the following pattern: ^[A-Z]{2}$.

        • scope string

          Indicates that the content being withheld is a user.

          Value is user.

      • profile_image_url string(uri)

        The URL to the profile image for this user.

      • 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 location queries.

      • url string

        The URL specified in the user's profile.

      • 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.

        Hide entities attributes Show entities attributes object

        • url object

          Expanded details for the URL specified in the user's profile, with start and end indices.

          Hide url attribute Show url attribute object

          • urls array[object]

            Represent the portion of text recognized as a URL.

            At least 1 element.

            Hide urls attributes Show urls attributes array[object]

            • start integer Required

              Index (zero-based) at which position this entity starts. The index is inclusive.

              Minimum value is 0.

            • end integer Required

              Index (zero-based) at which position this entity ends. The index is exclusive.

              Minimum value is 0.

            • url string(uri) Required

              A validly formatted URL.

            • expanded_url string(uri)

              A validly formatted URL.

            • display_url string

              The URL as displayed in the Twitter client.

            • unwound_url string(uri)

              Fully resolved url

            • status integer

              HTTP Status Code.

              Minimum value is 100, maximum value is 599.

            • title string

              Title of the page the URL points to.

            • description string

              Description of the URL landing page.

            • images array[object]

              Represent the information for the URL image

              At least 1 element.

              Hide images attributes Show images attributes array[object]

              • url string(uri)

                A validly formatted URL.

              • height integer

                The height of the media in pixels

                Minimum value is 0.

              • width integer

                The width of the media in pixels

                Minimum value is 0.

        • description object
          Hide description attributes Show description attributes object

          • urls array[object]

            Represent the portion of text recognized as a URL.

            At least 1 element.

            Hide urls attributes Show urls attributes array[object]

            • start integer Required

              Index (zero-based) at which position this entity starts. The index is inclusive.

              Minimum value is 0.

            • end integer Required

              Index (zero-based) at which position this entity ends. The index is exclusive.

              Minimum value is 0.

            • url string(uri) Required

              A validly formatted URL.

            • expanded_url string(uri)

              A validly formatted URL.

            • display_url string

              The URL as displayed in the Twitter client.

            • unwound_url string(uri)

              Fully resolved url

            • status integer

              HTTP Status Code.

              Minimum value is 100, maximum value is 599.

            • title string

              Title of the page the URL points to.

            • description string

              Description of the URL landing page.

            • images array[object]

              Represent the information for the URL image

              At least 1 element.

              Hide images attributes Show images attributes array[object]

              • url string(uri)

                A validly formatted URL.

              • height integer

                The height of the media in pixels

                Minimum value is 0.

              • width integer

                The width of the media in pixels

                Minimum value is 0.

          • hashtags array[object]

            Represent the portion of text recognized as a Hashtag, and its start and end position within the text.

            At least 1 element.

            Hide hashtags attributes Show hashtags attributes array[object]

            • start integer Required

              Index (zero-based) at which position this entity starts. The index is inclusive.

              Minimum value is 0.

            • end integer Required

              Index (zero-based) at which position this entity ends. The index is exclusive.

              Minimum value is 0.

            • tag string Required

              The text of the Hashtag

          • mentions array[object]

            Represent the portion of text recognized as a User mention, and its start and end position within the text.

            At least 1 element.

            Hide mentions attributes Show mentions attributes array[object]

            • start integer Required

              Index (zero-based) at which position this entity starts. The index is inclusive.

              Minimum value is 0.

            • end integer Required

              Index (zero-based) at which position this entity ends. The index is exclusive.

              Minimum value is 0.

            • username string Required

              The Twitter handle (screen name) of this user.

              Format should match the following pattern: ^[A-Za-z0-9_]{1,15}$.

            • id string Required

              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.

              Format should match the following pattern: ^[0-9]{1,19}$.

          • cashtags array[object]

            Represent the portion of text recognized as a Cashtag, and its start and end position within the text.

            At least 1 element.

            Hide cashtags attributes Show cashtags attributes array[object]

            • start integer Required

              Index (zero-based) at which position this entity starts. The index is inclusive.

              Minimum value is 0.

            • end integer Required

              Index (zero-based) at which position this entity ends. The index is exclusive.

              Minimum value is 0.

            • tag string Required
      • 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.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • public_metrics object

        A list of metrics for this user

        Hide public_metrics attributes Show public_metrics attributes object

        • followers_count integer Required

          Number of users who are following this user.

        • following_count integer Required

          Number of users this user is following.

        • tweet_count integer Required

          The number of Tweets (including Retweets) posted by this user.

        • listed_count integer Required

          The number of lists that include this user.

    • tweets array[object]

      At least 1 element.

      Hide tweets attributes Show tweets attributes array[object]

      • id string Required

        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.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • created_at string(date-time)

        Creation time of the Tweet.

      • text string Required

        The content of the Tweet.

      • author_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.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • in_reply_to_user_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.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • conversation_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.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • reply_settings string

        Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, and following.

        Format should match the following pattern: ^[A-Za-z]{1,12}$. Values are everyone, mentionedUsers, following, or other.

      • referenced_tweets array[object]

        A list of Tweets this Tweet refers to. For example, if the parent Tweet is a Retweet, a Quoted Tweet or a Reply, it will include the related Tweet referenced to by its parent.

        At least 1 element.

        Hide referenced_tweets attributes Show referenced_tweets attributes array[object]

        • type string Required

          Values are retweeted, quoted, or replied_to.

        • id string Required

          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.

          Format should match the following pattern: ^[0-9]{1,19}$.

      • attachments object

        Specifies the type of attachments (if any) present in this Tweet.

        Hide attachments attributes Show attachments attributes object

        • media_keys array[string]

          The Media Key identifier for this attachment.

          At least 1 element. Format of each should match the following pattern: ^([0-9]+)_([0-9]+)$.

        • poll_ids array[string]

          Unique identifier of this poll.

          At least 1 element. Format of each should match the following pattern: ^[0-9]{1,19}$.

      • context_annotations array[object]

        Annotation inferred from the tweet text.

        At least 1 element.

        Hide context_annotations attributes Show context_annotations attributes array[object]

        • domain object Required

          Represents the data for the context annotation domain.

          Hide domain attributes Show domain attributes object

          • id string Required

            The unique id for a context annotation domain.

            Format should match the following pattern: ^[0-9]{1,19}$.

          • name string

            Name of the context annotation domain.

          • description string

            Description of the context annotation domain.

        • entity object Required

          Represents the data for the context annotation entity.

          Hide entity attributes Show entity attributes object

          • id string Required

            The unique id for a context annotation entity.

            Format should match the following pattern: ^[0-9]{1,19}$.

          • name string

            Name of the context annotation entity.

          • description string

            Description of the context annotation entity.

      • withheld object

        Indicates withholding details for withheld content.

        Hide withheld attributes Show withheld attributes object

        • copyright boolean Required

          Indicates if the content is being withheld for on the basis of copyright infringement.

        • country_codes array[string] Required

          A two-letter ISO 3166-1 alpha-2 country code

          At least 1 element. Format of each should match the following pattern: ^[A-Z]{2}$.

        • scope string

          Indicates whether the content being withheld is the tweet or a user.

          Values are tweet or user.

      • geo object

        The location tagged on the Tweet, if the user provided one.

        Hide geo attributes Show geo attributes object

        • coordinates object

          A GeoJson Point geometry object.

          Hide coordinates attributes Show coordinates attributes object

          • type string Required

            Value is Point.

          • coordinates array[number] Required

            A GeoJson Position in the format [longitude,latitude].

            At least 2 but not more than 2 elements.

        • place_id string

          The identifier for this place

      • entities object
        Hide entities attributes Show entities attributes object

        • urls array[object]

          Represent the portion of text recognized as a URL.

          At least 1 element.

          Hide urls attributes Show urls attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • url string(uri) Required

            A validly formatted URL.

          • status integer

            HTTP Status Code.

            Minimum value is 100, maximum value is 599.

          • expanded_url string(uri)

            A validly formatted URL.

          • display_url string

            The URL as displayed in the Twitter client.

          • unwound_url string(uri)

            Fully resolved url

          • title string

            Title of the page the URL points to.

          • description string

            Description of the URL landing page.

          • images array[object]

            Represent the information for the URL image

            At least 1 element.

            Hide images attributes Show images attributes array[object]

            • url string(uri)

              A validly formatted URL.

            • height integer

              The height of the media in pixels

              Minimum value is 0.

            • width integer

              The width of the media in pixels

              Minimum value is 0.

        • hashtags array[object]

          Represent the portion of text recognized as a Hashtag, and its start and end position within the text.

          At least 1 element.

          Hide hashtags attributes Show hashtags attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • tag string Required

            The text of the Hashtag

        • mentions array[object]

          Represent the portion of text recognized as a User mention, and its start and end position within the text.

          At least 1 element.

          Hide mentions attributes Show mentions attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • username string Required

            The Twitter handle (screen name) of this user.

            Format should match the following pattern: ^[A-Za-z0-9_]{1,15}$.

          • id string Required

            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.

            Format should match the following pattern: ^[0-9]{1,19}$.

        • cashtags array[object]

          Represent the portion of text recognized as a Cashtag, and its start and end position within the text.

          At least 1 element.

          Hide cashtags attributes Show cashtags attributes array[object]

          • start integer Required

            Index (zero-based) at which position this entity starts. The index is inclusive.

            Minimum value is 0.

          • end integer Required

            Index (zero-based) at which position this entity ends. The index is exclusive.

            Minimum value is 0.

          • tag string Required
      • public_metrics object

        Engagement metrics for the Tweet at the time of the request.

        Hide public_metrics attributes Show public_metrics attributes object

        • retweet_count integer Required

          Number of times this Tweet has been Retweeted.

        • reply_count integer Required

          Number of times this Tweet has been replied to.

        • like_count integer Required

          Number of times this Tweet has been liked.

        • quote_count integer

          Number of times this Tweet has been quoted.

      • possibly_sensitive boolean

        Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences.

      • lang string

        Language of the Tweet, if detected by Twitter. Returned as a BCP47 language tag.

      • source string

        The name of the app the user Tweeted from.

      • non_public_metrics object

        Nonpublic engagement metrics for the Tweet at the time of the request.

        Hide non_public_metrics attribute Show non_public_metrics attribute object

        • impression_count integer(int32)

          Number of times this Tweet has been viewed.

      • promoted_metrics object

        Promoted nonpublic engagement metrics for the Tweet at the time of the request.

        Hide promoted_metrics attributes Show promoted_metrics attributes object

        • impression_count integer(int32)

          Number of times this Tweet has been viewed.

        • like_count integer(int32)

          Number of times this Tweet has been liked.

        • reply_count integer(int32)

          Number of times this Tweet has been replied to.

        • retweet_count integer(int32)

          Number of times this Tweet has been Retweeted.

      • organic_metrics object

        Organic nonpublic engagement metrics for the Tweet at the time of the request.

        Hide organic_metrics attributes Show organic_metrics attributes object

        • impression_count integer Required

          Number of times this Tweet has been viewed.

        • retweet_count integer Required

          Number of times this Tweet has been Retweeted.

        • reply_count integer Required

          Number of times this Tweet has been replied to.

        • like_count integer Required

          Number of times this Tweet has been liked.

    • places array[object]

      At least 1 element.

      Hide places attributes Show places attributes array[object]

      • geo object
        Hide geo attributes Show geo attributes object

        • type string Required

          Value is Feature.

        • bbox array[number(double)] Required

          At least 4 but not more than 4 elements. Minimum value of each is -180, maximum value of each is 180.

        • geometry object

          A GeoJson Point geometry object.

          Hide geometry attributes Show geometry attributes object

          • type string Required

            Value is Point.

          • coordinates array[number] Required

            A GeoJson Position in the format [longitude,latitude].

            At least 2 but not more than 2 elements.

        • properties object Required
      • id string Required

        The identifier for this place

      • name string

        The human readable name of this place.

      • country_code string

        A two-letter ISO 3166-1 alpha-2 country code

        Format should match the following pattern: ^[A-Z]{2}$.

      • place_type string

        Values are poi, neighborhood, city, admin, country, or unknown.

      • full_name string Required

        The full name of this place.

      • country string

        The full name of the county in which this place exists.

      • contained_within array[string]

        The identifier for this place

        At least 1 element.

    • media array[object]

      At least 1 element.

      Hide media attributes Show media attributes array[object]

      • type string Required
      • media_key string

        The Media Key identifier for this attachment.

        Format should match the following pattern: ^([0-9]+)_([0-9]+)$.

      • height integer

        The height of the media in pixels

        Minimum value is 0.

      • width integer

        The width of the media in pixels

        Minimum value is 0.

    • polls array[object]

      Represent a Poll attached to a Tweet

      At least 1 element.

      Hide polls attributes Show polls attributes array[object]

      • id string Required

        Unique identifier of this poll.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • options array[object] Required

        Describes a choice in a Poll object.

        At least 2 but not more than 4 elements.

        Hide options attributes Show options attributes array[object]

        • position integer Required

          Position of this choice in the poll.

        • label string Required

          The text of a poll choice.

          Minimum length is 1, maximum length is 25.

        • votes integer Required

          Number of users who voted for this choice.

      • voting_status string

        Values are open or closed.

      • end_datetime string(date-time)
      • duration_minutes integer
  • errors array[object]

    An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

    At least 1 element.

    Hide errors attributes Show errors attributes array[object]

    • type string Required
    • title string Required
    • detail string
    • status integer
  • meta object
    Hide meta attributes Show meta attributes object

    • previous_token string

      The previous token

      Format should match the following pattern: ^[a-zA-Z0-9]+$.

    • next_token string

      The next token

      Format should match the following pattern: ^[a-zA-Z0-9]+$.

    • result_count integer

      The number of user results returned in this response

• default

  The request has failed.

  Hide response attributes Show response attributes object

  • code integer(int32) Required
  • message string Required