Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Headers

Idempotency-Key
string

Makes a retry safe: the same key with the same request within 24 hours returns the first result (with Idempotent-Replayed: true) instead of writing again. The same key with a different request is a 409 conflict; while the first request still runs, 409 idempotency_processing.

Required string length: 1 - 255

Body

application/json
name
string
required

The list name, 1-200 characters.

Required string length: 1 - 200
Pattern: ^[^\u0000-\u001f\u007f]*$
folder_id
string

The folder to put it in (fld_...); leave out for a list on its own.

Required string length: 1 - 64
visibility
enum<string>

workspace (the default): every member of the workspace sees it. private is not accepted yet.

Available options:
workspace,
private
if_exists
enum<string>
default:create

create (default): always create a new one. return: if you can already see one with this name in the same place, return it instead (409 if its visibility differs).

Available options:
create,
return

Response

OK

object
string
required
Allowed value: "research.saved_list"
id
string
required

The list ID (lst_...).

name
string
required
folder_id
string | null
required

The folder it sits in (fld_...), or null for a list on its own.

visibility
enum<string>
required

workspace: every member of the workspace sees it. private: only the person who created it (an API key acts as the person who created the key).

Available options:
workspace,
private
item_count
integer
required

Saved items in the list.

Required range: x >= 0
item_types
enum<string>[]
required

The kinds of item the list holds. New kinds may be added.

Available options:
product,
shop,
keyword
created_by
string
required

The ID of the Alura user who created it.

created_at
string
required

When it was created (ISO 8601, UTC).

updated_at
string
required

When it last changed (ISO 8601, UTC). The last change wins.