Skip to main content
POST
/
v1
/
lists
/
search
Search lists
curl --request POST \
  --url https://api.stardex.ai/v1/lists/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offset": 0,
  "limit": 100,
  "sort_by": "created_at",
  "sort_order": "desc",
  "keywords": "<string>",
  "is_archived": false,
  "owner_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "is_public": true
}
'
{
  "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"
    }
  ],
  "meta": {
    "total": 100,
    "offset": 0,
    "limit": 20
  }
}

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.

Body

application/json
​
offset
integer
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
​
limit
integer
default:100

Max records to return (1–100). Defaults to 100.

Required range: 1 <= x <= 100
​
sort_by
enum<string>
default:created_at

Column to sort by. Accepted values: name, created_at, updated_at, item_count. Defaults to created_at.

Available options:
name,
created_at,
updated_at,
item_count
​
sort_order
enum<string>
default:desc

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc
​
keywords
string

Search keyword to filter lists by name. Case-insensitive partial match.

​
list_type
enum<string>

Filter by list type: "persons" or "companies". Omit to return all types.

Available options:
persons,
companies
​
is_archived
boolean
default:false

When true, return archived lists only. When false (default), return non-archived lists.

​
owner_ids
string<uuid>[]

Filter to lists owned by these team member UUIDs.

​
is_public
boolean

Filter by public/private visibility. Omit to return both.

Response

Successful search response

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required
​
meta
object
required