Skip to main content
GET
/
v1
/
lists
/
{id}
Get list by ID
curl --request GET \
  --url https://api.stardex.ai/v1/lists/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "aaa11111-bbbb-cccc-dddd-eeeeeeee1111",
    "name": "Engineering Candidates Q2",
    "list_type": "persons",
    "is_public": true,
    "is_archived": false,
    "linked_job_id": "fff66666-0000-1111-2222-333333336666",
    "linked_person_id": null,
    "linked_organization_company_id": null,
    "item_count": 42,
    "created_by": {
      "id": "bbb22222-cccc-dddd-eeee-ffffffff2222",
      "first_name": "Jane",
      "last_name": "Smith"
    },
    "owners": [
      {
        "id": "bbb22222-cccc-dddd-eeee-ffffffff2222",
        "first_name": "Jane",
        "last_name": "Smith"
      }
    ],
    "created_at": "2024-01-15T10:00:00Z",
    "updated_at": "2024-05-20T14:30:00Z",
    "items": [
      {
        "id": "eee55555-ffff-0000-1111-222222225555",
        "person": {
          "id": "ccc33333-dddd-eeee-ffff-000000003333",
          "first_name": "John",
          "last_name": "Doe",
          "linkedin_url": "https://linkedin.com/in/johndoe"
        },
        "company": null,
        "created_at": "2024-02-01T12:00:00Z"
      }
    ],
    "items_total": 42
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.stardex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string
required

List UUID

Query Parameters

items_offset
integer | null
default:0

Items to skip for pagination. Defaults to 0.

Required range: x >= 0
items_limit
integer
default:50

Max items to return (1–100). Defaults to 50.

Required range: 1 <= x <= 100

Response

List fetched

success
enum<boolean>
required
Available options:
true
data
object
required