Skip to main content
GET
/
lists
/
{listId}
Get list
curl --request GET \
  --url https://inboxapp.com/api/v1/lists/{listId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "description": "Leads scraped from Product Hunt launches",
  "profilesCount": 123,
  "reachableEstimate": 123,
  "reachableCount": 123,
  "columns": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
listId
string
required

The ID of the list to retrieve.

Pattern: ^[0-9a-z]+$

Response

200 - application/json

OK

​
id
string
required

Unique identifier for the list.

Pattern: ^[0-9a-z]+$
​
name
string
required

Display name of the list.

Example:

"Product Hunt Leads"

​
slug
string
required

URL-friendly slug for the list.

Example:

"product-hunt-leads"

​
icon
string
required

Icon name for the list.

Example:

"list"

​
color
string
required

Hex color code for the list.

Example:

"#3b82f6"

​
description
string | null
required

Optional description of the list.

Example:

"Leads scraped from Product Hunt launches"

​
profilesCount
number
required

Total number of profiles in the list.

Example:

1520

​
reachableEstimate
number | null
required

Estimated number of reachable profiles in the list.

​
reachableCount
number
required

Number of profiles that can be contacted.

Example:

1200

​
columns
object
required

Column definitions for the list.

​
createdAt
string<date-time>
required

When the list was created.

​
updatedAt
string<date-time> | null
required

When the list was last updated.