Get Root List

Retrieve the authenticated user’s root list

GET /:projectId/lists/root

Get Root List

cURL

curl --request GET \
  --url https://api.replyke.com/api/v6/:projectId/lists/root

200

{
  "id": "<string>",
  "projectId": "<string>",
  "userId": "<string>",
  "name": "<string>",
  "isRoot": true,
  "parentId": "<string>",
  "entityIds": [
    {}
  ],
  "subLists": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Retrieves the authenticated user’s root list. If it doesn’t exist, a new one is created automatically.

Response

id · string

Unique list identifier

projectId · string

Project identifier

userId · string

ID of the user who owns the list

name · string

Name of the list (always “root” for root lists)

isRoot · boolean

Indicates this is a root list (always true)

parentId · string

Parent list ID (always null for root lists)

entityIds · array

Array of entity IDs saved in this list

subLists · array

Array of nested sub-lists

createdAt · string

Creation timestamp in ISO 8601 format

updatedAt · string

Last update timestamp in ISO 8601 format

Error Responses

Server Error - 500 Internal Server Error

{
  "error": "Server error",
  "code": "list/server-error",
  "details": "<Error message>"
}

---

Notes

• Each user has a single root list per project.
• If the root list does not exist, it will be created automatically.
• The response includes all populated sub-lists and entity IDs if available.