Moab logoMoab
Get started
Moab Docs

Companies

Target accounts your campaign agents research and work.

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

GET /api/v1/companies

curl "https://moabcrm.com/api/v1/companies?segment=Small%20environmental%20firms" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest"
Show me the companies filtered by segment
data_query {
  "collection": "companies",
  "where": {
    "segment": "Small environmental firms"
  }
}

Returns a paginated list of company objects, newest first.

{
  "object": "list",
  "data": [
    {
      "object": "company",
      "id": "obj_123",
      "name": "Riverside Environmental Group",
      "domain": "riversideenv.com",
      "employee_count": 48,
      "segment": "Small environmental firms",
      "signal": "Opened a second pit office in Q2 and is hiring NEPA planners.",
      "research_status": "verified",
      "research_note": "Read the firm's site and two 2026 permit filings; NEPA consultancy serving federal land agencies, two offices.",
      "category": "Environmental consulting",
      "stage": "stage",
      "created_at": "2026-07-25T12:00:00.000Z",
      "updated_at": "2026-07-25T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Parameters

ParameterTypeKindDescription
segmentstringfilterThe ICP segment this account was sourced for — the campaign agent's slice.
stagestringfilterWorking stage for the account. Free text on purpose — nothing in the corpus writes a company stage, so an enum here would invent vocabulary.
categorystringfilterThe account's industry/category, as researched.
research_statusstringfilterverified — a source was actually read. unverified — named from the operator prompt only, never dressed up as verified detail. One of verified, unverified.
agent_idstringfilterThe campaign agent that currently owns this account.
created_by_agent_idstringfilterThe campaign agent that created this account. Read by the platform's object_created provenance hook to attribute the row's timeline entry.
qstringsearchFree-text search across name, domain.
sortstringsortOne of employee_count, leads_count, last_researched_at; prefix with - to reverse.
limitnumberpageRows to return, 1–100. Defaults to 20.
cursorstringpagenext_cursor from the previous page.

Retrieve a company

GET /api/v1/companies/draft-001

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

Returns the company object.

{
  "object": "company",
  "id": "obj_123",
  "name": "Riverside Environmental Group",
  "domain": "riversideenv.com",
  "employee_count": 48,
  "segment": "Small environmental firms",
  "signal": "Opened a second pit office in Q2 and is hiring NEPA planners.",
  "research_status": "verified",
  "research_note": "Read the firm's site and two 2026 permit filings; NEPA consultancy serving federal land agencies, two offices.",
  "category": "Environmental consulting",
  "stage": "stage",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

ParameterTypeKindDescription
idstringpathThe company's id or slug.

Create a company

POST /api/v1/companies

curl -X POST "https://moabcrm.com/api/v1/companies" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"name":"Riverside Environmental Group","domain":"riversideenv.com","employee_count":48,"segment":"Small environmental firms","category":"Environmental consulting","signal":"Opened a second pit office in Q2 and is hiring NEPA planners."}'
Create a new company
data_set {
  "collection": "companies",
  "object_id": "draft-001",
  "data": {
    "name": "Riverside Environmental Group",
    "domain": "riversideenv.com",
    "employee_count": 48,
    "segment": "Small environmental firms",
    "category": "Environmental consulting",
    "signal": "Opened a second pit office in Q2 and is hiring NEPA planners."
  }
}

Returns the company object.

{
  "object": "company",
  "id": "obj_123",
  "name": "Riverside Environmental Group",
  "domain": "riversideenv.com",
  "employee_count": 48,
  "segment": "Small environmental firms",
  "signal": "Opened a second pit office in Q2 and is hiring NEPA planners.",
  "research_status": "verified",
  "research_note": "Read the firm's site and two 2026 permit filings; NEPA consultancy serving federal land agencies, two offices.",
  "category": "Environmental consulting",
  "stage": "stage",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoThe company's name.
domainstringnoPrimary web domain — also what the logo fallback and dedupe key on.
employee_countnumbernoHeadcount, when research yields one. Mirrored onto people as company.employee_count.
segmentstringnoThe ICP segment this account was sourced for — the campaign agent's slice.
signaltextnoThe current research observation an opener may reference — a raise, an opening, a hire. Cached so the next campaign personalizes for free.
research_statusstringnoverified — a source was actually read. unverified — named from the operator prompt only, never dressed up as verified detail. One of verified, unverified.
research_notetextnoPlain sentence: what was checked, or why nothing was.
created_by_run_idstringnoThe campaign run that created this account — what the "Runs" cell links to.
leads_countnumbernoHow many people Moab holds at this account. Denormalised, so it can lag a run terminal — the People tile falls back to the live provenance count.
categorystringnoThe account's industry/category, as researched.
stagestringnoWorking stage for the account. Free text on purpose — nothing in the corpus writes a company stage, so an enum here would invent vocabulary.

Update a company

PATCH /api/v1/companies/draft-001

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

Returns the company object.

{
  "object": "company",
  "id": "obj_123",
  "name": "Riverside Environmental Group",
  "domain": "riversideenv.com",
  "employee_count": 48,
  "segment": "Small environmental firms",
  "signal": "Opened a second pit office in Q2 and is hiring NEPA planners.",
  "research_status": "verified",
  "research_note": "Read the firm's site and two 2026 permit filings; NEPA consultancy serving federal land agencies, two offices.",
  "category": "Environmental consulting",
  "stage": "stage",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoThe company's name.
domainstringnoPrimary web domain — also what the logo fallback and dedupe key on.
employee_countnumbernoHeadcount, when research yields one. Mirrored onto people as company.employee_count.
segmentstringnoThe ICP segment this account was sourced for — the campaign agent's slice.
signaltextnoThe current research observation an opener may reference — a raise, an opening, a hire. Cached so the next campaign personalizes for free.
research_statusstringnoverified — a source was actually read. unverified — named from the operator prompt only, never dressed up as verified detail. One of verified, unverified.
research_notetextnoPlain sentence: what was checked, or why nothing was.
created_by_run_idstringnoThe campaign run that created this account — what the "Runs" cell links to.
leads_countnumbernoHow many people Moab holds at this account. Denormalised, so it can lag a run terminal — the People tile falls back to the live provenance count.
categorystringnoThe account's industry/category, as researched.
stagestringnoWorking stage for the account. Free text on purpose — nothing in the corpus writes a company stage, so an enum here would invent vocabulary.

Append an event to a company

POST /api/v1/companies/{id}/events

curl -X POST "https://moabcrm.com/api/v1/companies/draft-001/events" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"event":"Noted by the operator","context":{"source":"api"}}'
Add a note to the company {id}
data_event {
  "collection": "companies",
  "object_id": "draft-001",
  "event": "Noted by the operator"
}

Returns the appended event object.

{
  "object": "event",
  "id": "evt_123",
  "event": "Noted by the operator"
}

Parameters

FieldTypeRequiredDescription
eventstringyesThe human-readable timeline entry.
contextobjectnoProvenance — source, integration, worker_run_id, …

What comes back (read-only)

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

FieldTypeDescription
objectstringAlways company.
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.
subdescriptiontextOne plain sentence about what the company does; rendered as the "About" panel.
yc_batchstringThe company's YC batch ("Winter 2024"), stamped from the yc-oss directory by the walk or the reconcile — never written by you.
yc_checked_atdateWhen the yc-oss directory was consulted for this company's domain. Set with no yc_batch = the company is not a YC company.
last_researched_atdateWhen this account was last researched. Stamped through the platform context.touch.fields primitive, never hand-written per record; a run reads it to decide whether a search is needed at all.
agent_idstringThe campaign agent that currently owns this account.
created_by_agent_idstringThe campaign agent that created this account. Read by the platform's object_created provenance hook to attribute the row's timeline entry.
created_by_agent_labelstringThat agent's NAME, denormalised alongside created_by_agent_id.
created_by_list_labelstringThe name of the list this account was sourced from, denormalised the same way.

Errors

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