Skip to main content
POST
/
v1
/
lists
Create list
curl --request POST \
  --url https://api.stardex.ai/v1/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "list_type": "persons",
  "is_public": false,
  "linked_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "linked_person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "linked_organization_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "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,
    "created_at": "2024-01-15T10:00:00Z"
  }
}

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
​
name
string
required

List name (required).

Minimum string length: 1
​
list_type
enum<string>
default:persons

Type of entities in this list. Defaults to "persons".

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

Whether the list is visible to all team members. Defaults to false.

​
linked_job_id
string<uuid>

Job UUID to link this list to.

​
linked_person_id
string<uuid>

Person UUID to link this list to.

​
linked_organization_company_id
string<uuid>

Company UUID to link this list to.

​
owner_ids
string<uuid>[]

Team member UUIDs to assign as list owners. If omitted, the caller is auto-assigned.

Response

List created

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