Skip to main content
GET
Get list details

Authorizations

x-api-key
string
header
required

Your ScrapeBadger API key. You can find this in your dashboard at https://scrapebadger.com/dashboard/api-keys.

Path Parameters

list_id
string
required

The unique numeric ID of the list.

Example:

"1580582120482430976"

Response

Successfully retrieved list details.

Twitter list metadata.

id
string
required

Unique list identifier.

Example:

"1580582120482430976"

name
string
required

Name of the list.

Example:

"Tech Leaders"

description
string | null

Description of the list.

created_at
string | null

Timestamp when the list was created.

member_count
integer | null

Number of members in the list.

subscriber_count
integer | null

Number of subscribers to the list.

mode
enum<string> | null

Visibility mode of the list.

Available options:
public,
private
user_id
string | null

Numeric ID of the list owner.

username
string | null

Username of the list owner.