RErecruitwithatlas
Lists

Create a list

Changed on

Creates a list owned by your API key's user. visibility defaults to private and editable to true. Optional personIds are inserted in the same transaction as the list, so an invalid or cross-agency person ID rolls the whole create back with a 422 — no orphan empty list is left behind. At most 100 person IDs per request; add the rest with POST /lists/{id}/members.

post/api/v1/lists

Request

Request body

namestring required

List name

entityType'candidate' | 'contact' required

What the list holds — people or company contacts

personIdsstring[]

Initial members, added in the same transaction as the list

visibility'public' | 'team' | 'private'

Defaults to private when omitted

editableboolean

Whether users who can see the list may change its members. Defaults to true when omitted

Example request

{
  "name": "Senior React engineers",
  "entityType": "candidate",
  "personIds": [
    "3f1c9d2e-8a45-4c7b-9f01-2d6e5b4a7c31"
  ],
  "visibility": "team"
}

Response

List created

status'ok' required

Changes