Moab logoMoab
Get started
Moab Docs

Lists

Saved groups of people and companies one campaign run works.

Base path /api/v1/lists on https://moabcrm.com. Authenticate with Authorization: Bearer $DASH_API_KEY and name the project with the Project-ID header. Writes are validated in declared mode; an operation this resource does not declare answers 405 operation_not_supported.

List lists

GET /api/v1/lists

curl "https://moabcrm.com/api/v1/lists" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest"
Show me the lists filtered by created by agent id
data_query {
  "collection": "lists"
}

Returns a paginated list of list objects, newest first.

{
  "object": "list",
  "data": [
    {
      "object": "list",
      "id": "obj_123",
      "name": "name",
      "criteria": "criteria",
      "created_at": "2026-07-25T12:00:00.000Z",
      "updated_at": "2026-07-25T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Parameters

ParameterTypeKindDescription
created_by_agent_idstringfilterThe campaign agent that created this list, read by the provenance hook.
created_by_run_idstringfilterThe campaign run that created this list — what the "Runs" cell links to.
qstringsearchFree-text search across name, criteria.
sortstringsortOne of leads_count; prefix with - to reverse.
limitnumberpageRows to return, 1–100. Defaults to 20.
cursorstringpagenext_cursor from the previous page.

Retrieve a list

GET /api/v1/lists/draft-001

curl "https://moabcrm.com/api/v1/lists/draft-001" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest"
Open the list {id}
data_get {
  "collection": "lists",
  "object_id": "draft-001"
}

Returns the list object.

{
  "object": "list",
  "id": "obj_123",
  "name": "name",
  "criteria": "criteria",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

ParameterTypeKindDescription
idstringpathThe list's id or slug.

Create a list

POST /api/v1/lists

curl -X POST "https://moabcrm.com/api/v1/lists" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"name":"name","criteria":"criteria"}'
Create a new list
data_set {
  "collection": "lists",
  "object_id": "draft-001",
  "data": {
    "name": "name",
    "criteria": "criteria"
  }
}

Returns the list object.

{
  "object": "list",
  "id": "obj_123",
  "name": "name",
  "criteria": "criteria",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoHuman name of the saved segment.
criteriatextnoThe segment definition in plain words — who belongs on this list and why.

Update a list

PATCH /api/v1/lists/draft-001

curl -X PATCH "https://moabcrm.com/api/v1/lists/draft-001" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"name":"name","criteria":"criteria"}'
Update the list {id}
data_set {
  "collection": "lists",
  "object_id": "draft-001",
  "data": {
    "name": "name",
    "criteria": "criteria"
  }
}

Returns the list object.

{
  "object": "list",
  "id": "obj_123",
  "name": "name",
  "criteria": "criteria",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoHuman name of the saved segment.
criteriatextnoThe segment definition in plain words — who belongs on this list and why.

What comes back (read-only)

Every list carries the envelope below. The fields under it are computed or stamped by the platform — they are returned, never sent.

FieldTypeDescription
objectstringAlways list.
idstringStable object id. Also accepted in place of slug on any path.
slugstringURL-safe name, unique within the collection.
created_atstringISO-8601 timestamp of the first write.
updated_atstringISO-8601 timestamp of the most recent write. The cursor sorts on this.
leads_countnumberHow many people the list currently holds. Membership itself lives on people.list_ids.
created_by_run_idstringThe campaign run that created this list — what the "Runs" cell links to.
created_by_agent_idstringThe campaign agent that created this list, read by the provenance hook.
created_by_agent_labelstringThat agent's name, denormalised so the run bubble renders without a join.

Errors

Failures use { error: { type, code, message, param } }. The full code table is generated at Error Codes.

On this page

Moab logoMoab

Ready to build? Connect an agent and go — no credit card needed to start.

Get startedSee our plans