Moab logoMoab
Get started
Moab Docs

Employees

The sender personas outreach is written as.

Base path /api/v1/employees 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 employees

GET /api/v1/employees

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

Returns a paginated list of employee objects, newest first.

{
  "object": "list",
  "data": [
    {
      "object": "employee",
      "id": "obj_123",
      "name": "name",
      "role": "role",
      "status": "active",
      "email": "person@example.com",
      "calendar_url": "calendar url",
      "voice_md": "voice md",
      "signature": "signature",
      "examples": [],
      "created_at": "2026-07-25T12:00:00.000Z",
      "updated_at": "2026-07-25T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Parameters

ParameterTypeKindDescription
rolestringfilterTheir role at the company, shown on the roster and used to pick a sender for a segment.
qstringsearchFree-text search across name, email.
sortstringsortOne of name; prefix with - to reverse.
limitnumberpageRows to return, 1–100. Defaults to 20.
cursorstringpagenext_cursor from the previous page.

Retrieve a employee

GET /api/v1/employees/draft-001

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

Returns the employee object.

{
  "object": "employee",
  "id": "obj_123",
  "name": "name",
  "role": "role",
  "status": "active",
  "email": "person@example.com",
  "calendar_url": "calendar url",
  "voice_md": "voice md",
  "signature": "signature",
  "examples": [],
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

ParameterTypeKindDescription
idstringpathThe employee's id or slug.

Create a employee

POST /api/v1/employees

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

Returns the employee object.

{
  "object": "employee",
  "id": "obj_123",
  "name": "name",
  "role": "role",
  "status": "active",
  "email": "person@example.com",
  "calendar_url": "calendar url",
  "voice_md": "voice md",
  "signature": "signature",
  "examples": [],
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoThe persona's full name — outreach signs with the first name only.
rolestringnoTheir role at the company, shown on the roster and used to pick a sender for a segment.
statusstringnoThe persona ladder. active writes and sends as this persona; paused refuses new drafts at the mint (employee_paused) and flags pending ones at Approve. Absent means active. One of active, paused.
emailstringnoThe person's real inbox, informational only — the wire from-address comes from the moab.channels sender config entry tagged with this record.
calendar_urlstringnoOptional booking/calendar link for this persona. When set, drafts sent as this persona may add "or book my calendar: <link>" to the CTA sentence.
voice_mdtextnoThe persona voice — operator-editable markdown voice guide the drafting passes write copy as: tone, concerns, and what this persona would never say.
signaturestringnoHow this persona signs an email — first name only by convention, kept per-employee so a second persona never signs with the operator's name.
examplesarraynoExample content pieces in this persona's voice, used as style references when drafting.

Update a employee

PATCH /api/v1/employees/draft-001

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

Returns the employee object.

{
  "object": "employee",
  "id": "obj_123",
  "name": "name",
  "role": "role",
  "status": "active",
  "email": "person@example.com",
  "calendar_url": "calendar url",
  "voice_md": "voice md",
  "signature": "signature",
  "examples": [],
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoThe persona's full name — outreach signs with the first name only.
rolestringnoTheir role at the company, shown on the roster and used to pick a sender for a segment.
statusstringnoThe persona ladder. active writes and sends as this persona; paused refuses new drafts at the mint (employee_paused) and flags pending ones at Approve. Absent means active. One of active, paused.
emailstringnoThe person's real inbox, informational only — the wire from-address comes from the moab.channels sender config entry tagged with this record.
calendar_urlstringnoOptional booking/calendar link for this persona. When set, drafts sent as this persona may add "or book my calendar: <link>" to the CTA sentence.
voice_mdtextnoThe persona voice — operator-editable markdown voice guide the drafting passes write copy as: tone, concerns, and what this persona would never say.
signaturestringnoHow this persona signs an email — first name only by convention, kept per-employee so a second persona never signs with the operator's name.
examplesarraynoExample content pieces in this persona's voice, used as style references when drafting.

What comes back (read-only)

Every employee carries the envelope below. This resource declares no server-owned fields beyond it.

FieldTypeDescription
objectstringAlways employee.
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.

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