Create a list

curl --request POST \
  --url https://apix.spotzee.com/api/client/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "High-value customers",
  "type": "dynamic",
  "rule": {
    "uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
    "path": "data.country",
    "operator": "<string>",
    "id": 123,
    "root_uuid": "<string>",
    "parent_uuid": "<string>",
    "value": "<string>",
    "children": "<array>"
  }
}
'

import requests

url = "https://apix.spotzee.com/api/client/lists"

payload = {
    "name": "High-value customers",
    "type": "dynamic",
    "rule": {
        "uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
        "path": "data.country",
        "operator": "<string>",
        "id": 123,
        "root_uuid": "<string>",
        "parent_uuid": "<string>",
        "value": "<string>",
        "children": "<array>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'High-value customers',
    type: 'dynamic',
    rule: {
      uuid: 'b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91',
      path: 'data.country',
      operator: '<string>',
      id: 123,
      root_uuid: '<string>',
      parent_uuid: '<string>',
      value: '<string>',
      children: '<array>'
    }
  })
};

fetch('https://apix.spotzee.com/api/client/lists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/client/lists"

	payload := strings.NewReader("{\n  \"name\": \"High-value customers\",\n  \"type\": \"dynamic\",\n  \"rule\": {\n    \"uuid\": \"b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91\",\n    \"path\": \"data.country\",\n    \"operator\": \"<string>\",\n    \"id\": 123,\n    \"root_uuid\": \"<string>\",\n    \"parent_uuid\": \"<string>\",\n    \"value\": \"<string>\",\n    \"children\": \"<array>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": 91,
  "project_id": 42,
  "name": "Newsletter subscribers — Q2 2026",
  "type": "static",
  "state": "draft",
  "version": 3,
  "is_visible": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "rule": {
    "uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
    "type": "wrapper",
    "group": "user",
    "path": "data.country",
    "operator": "<string>",
    "id": 123,
    "root_uuid": "<string>",
    "parent_uuid": "<string>",
    "value": "<string>",
    "frequency": {
      "period": {
        "type": "rolling",
        "unit": "hour",
        "value": 123
      },
      "operator": "=",
      "count": 123
    },
    "children": "<array>"
  },
  "rule_id": 123,
  "users_count": 12584,
  "tags": [
    "<string>"
  ],
  "refreshed_at": "<string>"
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

POST

lists

Create a list

curl --request POST \
  --url https://apix.spotzee.com/api/client/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "High-value customers",
  "type": "dynamic",
  "rule": {
    "uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
    "path": "data.country",
    "operator": "<string>",
    "id": 123,
    "root_uuid": "<string>",
    "parent_uuid": "<string>",
    "value": "<string>",
    "children": "<array>"
  }
}
'

import requests

url = "https://apix.spotzee.com/api/client/lists"

payload = {
    "name": "High-value customers",
    "type": "dynamic",
    "rule": {
        "uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
        "path": "data.country",
        "operator": "<string>",
        "id": 123,
        "root_uuid": "<string>",
        "parent_uuid": "<string>",
        "value": "<string>",
        "children": "<array>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'High-value customers',
    type: 'dynamic',
    rule: {
      uuid: 'b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91',
      path: 'data.country',
      operator: '<string>',
      id: 123,
      root_uuid: '<string>',
      parent_uuid: '<string>',
      value: '<string>',
      children: '<array>'
    }
  })
};

fetch('https://apix.spotzee.com/api/client/lists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/client/lists"

	payload := strings.NewReader("{\n  \"name\": \"High-value customers\",\n  \"type\": \"dynamic\",\n  \"rule\": {\n    \"uuid\": \"b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91\",\n    \"path\": \"data.country\",\n    \"operator\": \"<string>\",\n    \"id\": 123,\n    \"root_uuid\": \"<string>\",\n    \"parent_uuid\": \"<string>\",\n    \"value\": \"<string>\",\n    \"children\": \"<array>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": 91,
  "project_id": 42,
  "name": "Newsletter subscribers — Q2 2026",
  "type": "static",
  "state": "draft",
  "version": 3,
  "is_visible": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "rule": {
    "uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
    "type": "wrapper",
    "group": "user",
    "path": "data.country",
    "operator": "<string>",
    "id": 123,
    "root_uuid": "<string>",
    "parent_uuid": "<string>",
    "value": "<string>",
    "frequency": {
      "period": {
        "type": "rolling",
        "unit": "hour",
        "value": 123
      },
      "operator": "=",
      "count": 123
    },
    "children": "<array>"
  },
  "rule_id": 123,
  "users_count": 12584,
  "tags": [
    "<string>"
  ],
  "refreshed_at": "<string>"
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

Authorizations

Authorization

string

header

required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Body

application/json

Option 1
Option 2

Create a new list. The type discriminator chooses between dynamic (rule-driven) and static (manual) membership.

name

string

required

Human-readable list name.

Minimum string length: 1

Example:

"High-value customers"

type

enum<string>

required

Available options:

dynamic

rule

object

required

Membership rule tree. Members are materialised from this rule.

Hide child attributes

rule.uuid

string

required

Stable client-supplied UUID for this rule node — preserved across edits.

Example:

"b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91"

rule.type

enum<string>

required

Type of value the rule node holds. wrapper is a logical group; the rest are leaf comparisons.

Available options:

wrapper,

string,

number,

boolean,

date,

array,

shopify_purchase

rule.group

enum<string>

required

Where the rule applies — to the user (user), an event (event), or inherited from the parent wrapper.

Available options:

user,

event,

parent

rule.path

string

required

Dotted path on the user or event payload. For wrappers, leave empty.

Example:

"data.country"

rule.operator

string

required

Comparison or logical operator. See RuleOperator for the canonical list.

rule.id

number | null

Internal numeric identifier of a persisted rule node. Omit on create.

rule.root_uuid

string | null

UUID of the root wrapper of the rule tree this node belongs to.

rule.parent_uuid

string | null

UUID of the immediate parent wrapper.

rule.value

Right-hand side of a leaf comparison. Omitted on wrapper nodes.

rule.frequency

object

Required event count and operator over a time period — used by event-frequency rules.

Hide child attributes

rule.frequency.period

object

required

Time window for an event-frequency rule — rolling (relative) or fixed (absolute).

Option 1
Option 2

Hide child attributes

rule.frequency.period.type

enum<string>

required

Available options:

rolling

rule.frequency.period.unit

enum<string>

required

Available options:

hour,

minute,

day,

week,

month,

year

rule.frequency.period.value

number

required

rule.frequency.operator

enum<string>

required

Available options:

=,

<,

<=,

>,

>=

rule.frequency.count

number

required

rule.children

array | null

Nested rule nodes — present on wrapper types.

Response

The newly created list.

A static or dynamic group of users. Used to send campaigns and as a segment input.

integer

required

Numeric list identifier.

Example:

91

project_id

integer

required

Identifier of the project the list belongs to.

Example:

42

name

string

required

Human-readable list name.

Example:

"Newsletter subscribers — Q2 2026"

type

enum<string>

required

A static list has explicit members. A dynamic list is materialised from a rule tree.

Available options:

static,

dynamic

state

enum<string>

required

Current list state. loading while a refresh is in progress; ready once members are materialised.

Available options:

draft,

ready,

loading

version

integer

required

Monotonically incrementing version. Bumped on rule edits.

Example:

3

is_visible

boolean

required

Whether the list is shown in the in-product UI list directory.

created_at

string | null

required

Time the list was created. ISO 8601.

updated_at

string | null

required

Time the list was last modified. ISO 8601.

rule

object

Membership rule tree for dynamic lists. Absent on static lists.

Hide child attributes

rule.uuid

string

required

Stable client-supplied UUID for this rule node — preserved across edits.

Example:

"b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91"

rule.type

enum<string>

required

Type of value the rule node holds. wrapper is a logical group; the rest are leaf comparisons.

Available options:

wrapper,

string,

number,

boolean,

date,

array,

shopify_purchase

rule.group

enum<string>

required

Where the rule applies — to the user (user), an event (event), or inherited from the parent wrapper.

Available options:

user,

event,

parent

rule.path

string

required

Dotted path on the user or event payload. For wrappers, leave empty.

Example:

"data.country"

rule.operator

string

required

Comparison or logical operator. See RuleOperator for the canonical list.

rule.id

number | null

Internal numeric identifier of a persisted rule node. Omit on create.

rule.root_uuid

string | null

UUID of the root wrapper of the rule tree this node belongs to.

rule.parent_uuid

string | null

UUID of the immediate parent wrapper.

rule.value

Right-hand side of a leaf comparison. Omitted on wrapper nodes.

rule.frequency

object

Required event count and operator over a time period — used by event-frequency rules.

Hide child attributes

rule.frequency.period

object

required

Time window for an event-frequency rule — rolling (relative) or fixed (absolute).

Option 1
Option 2

Hide child attributes

rule.frequency.period.type

enum<string>

required

Available options:

rolling

rule.frequency.period.unit

enum<string>

required

Available options:

hour,

minute,

day,

week,

month,

year

rule.frequency.period.value

number

required

rule.frequency.operator

enum<string>

required

Available options:

=,

<,

<=,

>,

>=

rule.frequency.count

number

required

rule.children

array | null

Nested rule nodes — present on wrapper types.

rule_id

integer | null

Internal identifier of the persisted root rule, when present.

users_count

integer | null

Cached size of the list. May lag a few seconds behind reality.

Example:

12584

Overview

Projects

Events

Campaigns

Lists

Subscriptions

Journeys

Templates

Users

Tags

API keys

Organisation

Billing recovery

Webhooks

CRM

Source Sync

Form definitions

Form submissions

Create a list

Authorizations

Body

Response