Nolmo API 1.0.0

GET /v1/me

Who is calling

The key's name, workspace, scopes and groups. Every answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset.

200 Successful Response

Body application/json: Me

{
  "all_groups": false,
  "groups": [
    {
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f8",
      "name": "Support"
    }
  ],
  "key": {
    "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
    "name": "Contact form",
    "prefix": "nolmo_live_k3J9fQ2a"
  },
  "scopes": [
    "cases:read",
    "cases:write"
  ],
  "tenant": {
    "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f7",
    "name": "Furu & Lin",
    "slug": "furu-lin"
  }
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/cases/search

Search cases

Find cases by what was said in them, from the cases the key sees. A case in a group the key does not see is never found, with or without a filter.

This is the app's own search, so the inbox and the API find the same cases. Searching the team's internal notes too is opt-in with include_notes. Page with after, as with GET /v1/cases.

Parameters

200 Successful Response

Body application/json: CaseList

{
  "items": [
    {
      "channel": "api",
      "contact": {
        "email": "kari@example.no",
        "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
        "language": "nb",
        "name": "Kari Kunde"
      },
      "created_at": "2026-11-09T09:00:00Z",
      "custom_fields": {},
      "external_ref": "order-12345",
      "group_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "last_message_at": "2026-11-09T09:00:00Z",
      "number": 1042,
      "priority": "normal",
      "source": "Returns page",
      "status": "new",
      "subject": "Cracked tiles in the delivery",
      "tags": [
        "delivery"
      ],
      "updated_at": "2026-11-09T09:00:00Z",
      "version": 1
    }
  ]
}

400 A filter is not an id, or the cursor is not one this API issued

Body application/json: ErrorResponse

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/cases/{number}/attachments

List a case's files

The files on the case's messages, oldest first, a page at a time. Files on the team's internal notes are left out unless include_notes is true. Download one with GET /v1/attachments/{id}.

Parameters

200 Successful Response

Body application/json: CaseFileList

{
  "items": [
    {
      "content_type": "image/jpeg",
      "created_at": "2026-11-09T10:30:00Z",
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "message_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "name": "damaged-tiles.jpg",
      "on": "message",
      "size": 183204
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

404 No such case or file, or one in a group the key does not see

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/attachments/{attachment_id}

Download a file

The file, or a redirect (307) to a signed address that lives for a few minutes and carries no key; follow it without sending your Authorization header on. A file on a case the key does not see, a file on an internal note (unless include_notes is true) and an id that does not exist are the same 404.

Parameters

200 The file itself

Body application/octet-stream: string (binary)

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

404 No such case or file, or one in a group the key does not see

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

307 A signed URL that works for a few minutes; follow it

GET /v1/cases/{number}/events

List a case's events

What happened to the case, oldest first, a page at a time: when it was made, each reply, and every change of status, assignee, priority or type, with who did it. A person is a first name, a key is its name.

The kinds are created, customer_replied, team_replied, status_changed, reopened, assigned, priority_changed and type_changed. Other kinds may be added later; ignore the ones you do not know. Nothing about the workspace's clocks, the AI's work or the team's notes is part of it.

Parameters

200 Successful Response

Body application/json: CaseEventList

{
  "items": [
    {
      "actor": {
        "name": "Astrid",
        "type": "team"
      },
      "at": "2026-11-09T11:02:00Z",
      "from": "open",
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "kind": "status_changed",
      "to": "solved"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

404 No such case or file, or one in a group the key does not see

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/cases

List or find cases

The cases the key sees, newest first. A case in a group the key does not see is not listed, and not found by its external_ref either.

To find the case you made, send its external_ref (and the source you made it under, if you gave one).

Parameters

200 Successful Response

Body application/json: CaseList

{
  "items": [
    {
      "channel": "api",
      "contact": {
        "email": "kari@example.no",
        "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
        "language": "nb",
        "name": "Kari Kunde"
      },
      "created_at": "2026-11-09T09:00:00Z",
      "custom_fields": {},
      "external_ref": "order-12345",
      "group_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "last_message_at": "2026-11-09T09:00:00Z",
      "number": 1042,
      "priority": "normal",
      "source": "Returns page",
      "status": "new",
      "subject": "Cracked tiles in the delivery",
      "tags": [
        "delivery"
      ],
      "updated_at": "2026-11-09T09:00:00Z",
      "version": 1
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope, or the group is not one of the key's

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/cases

Create a case

Create a case for a person, with what they wrote as its first message.

The person is found by email, then phone, then an id in external_ids, and made when none is known. The case is routed by the workspace's rules, gets its clocks and is assessed, exactly as a mail would. It arrives on the channel api, and its timeline says which key made it.

Send an Idempotency-Key so that a retry makes no second case. An external_ref finds the case again (GET /v1/cases?external_ref=); a second create with the same external_ref and source is 409 external_ref_taken and names the case that has it.

Parameters

Request body application/json: CaseIn

{
  "contact": {
    "email": "kari@example.no",
    "name": "Kari Kunde"
  },
  "external_ref": "order-12345",
  "message": {
    "body_text": "Three of the tiles in the pack were cracked. Order 12345."
  },
  "priority": "normal",
  "source": "Returns page",
  "subject": "Cracked tiles in the delivery",
  "tags": [
    "delivery"
  ]
}

201 Successful Response

Body application/json: Case

{
  "channel": "api",
  "contact": {
    "email": "kari@example.no",
    "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
    "language": "nb",
    "name": "Kari Kunde"
  },
  "created_at": "2026-11-09T09:00:00Z",
  "custom_fields": {},
  "external_ref": "order-12345",
  "group_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "last_message_at": "2026-11-09T09:00:00Z",
  "number": 1042,
  "priority": "normal",
  "source": "Returns page",
  "status": "new",
  "subject": "Cracked tiles in the delivery",
  "tags": [
    "delivery"
  ],
  "updated_at": "2026-11-09T09:00:00Z",
  "version": 1
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope, or the group is not one of the key's

Body application/json: ErrorResponse

409 The case has changed, is closed, or the `external_ref` is taken

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/cases/{number}

Get a case

One case by its number. A case in a group the key does not see is a 404.

Parameters

200 Successful Response

Body application/json: Case

{
  "channel": "api",
  "contact": {
    "email": "kari@example.no",
    "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
    "language": "nb",
    "name": "Kari Kunde"
  },
  "created_at": "2026-11-09T09:00:00Z",
  "custom_fields": {},
  "external_ref": "order-12345",
  "group_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "last_message_at": "2026-11-09T09:00:00Z",
  "number": 1042,
  "priority": "normal",
  "source": "Returns page",
  "status": "new",
  "subject": "Cracked tiles in the delivery",
  "tags": [
    "delivery"
  ],
  "updated_at": "2026-11-09T09:00:00Z",
  "version": 1
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope, or the group is not one of the key's

Body application/json: ErrorResponse

404 No such case, or one in a group the key does not see

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

PATCH /v1/cases/{number}

Change a case

Change a case's tags, priority, custom fields or external_ref. Status and assignment are the team's, and sending them is a 422. Send the version you read: if the case has moved on the answer is 409 case_changed, and nothing is written.

Parameters

Request body application/json: CasePatchIn

{
  "priority": "high",
  "tags": [
    "delivery",
    "refund"
  ],
  "version": 3
}

200 Successful Response

Body application/json: Case

{
  "channel": "api",
  "contact": {
    "email": "kari@example.no",
    "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
    "language": "nb",
    "name": "Kari Kunde"
  },
  "created_at": "2026-11-09T09:00:00Z",
  "custom_fields": {},
  "external_ref": "order-12345",
  "group_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "last_message_at": "2026-11-09T09:00:00Z",
  "number": 1042,
  "priority": "normal",
  "source": "Returns page",
  "status": "new",
  "subject": "Cracked tiles in the delivery",
  "tags": [
    "delivery"
  ],
  "updated_at": "2026-11-09T09:00:00Z",
  "version": 1
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope, or the group is not one of the key's

Body application/json: ErrorResponse

404 No such case, or one in a group the key does not see

Body application/json: ErrorResponse

409 The case has changed, is closed, or the `external_ref` is taken

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/cases/{number}/messages

List a case's messages

The case's public thread, oldest first, a page at a time. The team's internal notes are not part of it unless include_notes is true; a side conversation never is.

Parameters

200 Successful Response

Body application/json: MessageList

{
  "items": [
    {
      "attachments": [],
      "author": {
        "name": "Astrid",
        "type": "team"
      },
      "body_text": "Hi Kari, we are sending new tiles today.",
      "created_at": "2026-11-09T10:30:00Z",
      "delivery": "sent",
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "kind": "reply"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope, or the group is not one of the key's

Body application/json: ErrorResponse

404 No such case, or one in a group the key does not see

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/cases/{number}/messages

Add a message to a case

Add to a case. kind says what it is:

• customer: a message from the person the case is about. It reopens a solved case, as a mail would, and is refused (409 case_closed) on a closed one.
• note: internal, for the team, authored by the key. It is never part of the public thread.
• reply: a public answer to the customer, sent through the case's channel as a team reply is (by email for an email case), authored by the key. It needs the scope cases:reply; without it the answer is 403 and nothing is written. The key does not become the case's assignee. If nothing can carry the answer (no address, no channel) it is 409 no_way_to_answer and nothing is written.

Parameters

Request body application/json: MessageIn

{
  "body_text": "Any news on this? I still have not heard anything.",
  "kind": "customer"
}

201 Successful Response

Body application/json: Message

{
  "attachments": [],
  "author": {
    "name": "Astrid",
    "type": "team"
  },
  "body_text": "Hi Kari, we are sending new tiles today.",
  "created_at": "2026-11-09T10:30:00Z",
  "delivery": "sent",
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "kind": "reply"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope, or the group is not one of the key's

Body application/json: ErrorResponse

404 No such case, or one in a group the key does not see

Body application/json: ErrorResponse

409 The case has changed, is closed, or the `external_ref` is taken

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/uploads

Upload a file

Upload a file as multipart/form-data (the part is called file), then name its id in attachments of a new case or of a message. The same kinds of file and the same size limit as in the app apply (pictures, documents, archives, mail, text; not pages or scripts). A file is yours until a message uses it, and only you can use it; one that is never used is deleted after a day.

Parameters

Request body multipart/form-data: Body_upload_file_v1_uploads_post

201 Successful Response

Body application/json: Upload

{
  "content_type": "image/jpeg",
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "name": "damaged-tiles.jpg",
  "size": 183204
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope, or the group is not one of the key's

Body application/json: ErrorResponse

413 The file is larger than the limit

Body application/json: ErrorResponse

415 That kind of file cannot be attached

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/contacts

List or find contacts

The workspace's contacts, by name, a page at a time. Every filter narrows the list; email, phone and external_system with external_id are exact matches, so they find the one person you know. A key sees every contact, whatever its groups; the counts are of the cases it sees.

Parameters

200 Successful Response

Body application/json: CustomerList

{
  "items": [
    {
      "case_counts": {
        "cases": 3,
        "last_contact_at": "2026-10-20T08:15:00Z",
        "open": 1
      },
      "created_at": "2026-09-02T10:00:00Z",
      "customer_no": "10442",
      "email": "kari@example.no",
      "external_ids": {
        "shop": "C-1042"
      },
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "language": "nb",
      "name": "Kari Kunde",
      "organization_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
      "organization_name": "Fliser AS",
      "phone": "+4790000000",
      "updated_at": "2026-10-20T08:15:00Z"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/contacts

Create a contact

Make a contact. A person is never made twice: when the email address, the phone number (as digits) or an id in external_ids already belongs to a contact, nothing is written and the answer is 409 contact_exists with that contact's id in details.contact_id. Look the person up first with GET /v1/contacts, or just create and read the 409. A person with an address on a company's domain joins that company, as for a mail.

Send an Idempotency-Key so that a retry makes nothing twice.

Parameters

Request body application/json: CustomerIn

{
  "email": "kari@example.no",
  "external_ids": {
    "shop": "C-1042"
  },
  "language": "nb",
  "name": "Kari Kunde",
  "phone": "+47 900 00 000"
}

201 Successful Response

Body application/json: Customer

{
  "case_counts": {
    "cases": 3,
    "last_contact_at": "2026-10-20T08:15:00Z",
    "open": 1
  },
  "created_at": "2026-09-02T10:00:00Z",
  "customer_no": "10442",
  "email": "kari@example.no",
  "external_ids": {
    "shop": "C-1042"
  },
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "name": "Kari Kunde",
  "organization_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
  "organization_name": "Fliser AS",
  "phone": "+4790000000",
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such contact or company, or a company named in the body does not exist

Body application/json: ErrorResponse

409 The email, phone number or external id is held by another, or the name is taken; `details` names the existing one

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/contacts/{contact_id}

Get a contact

One contact by id, with the counts of their cases the key sees.

Parameters

200 Successful Response

Body application/json: Customer

{
  "case_counts": {
    "cases": 3,
    "last_contact_at": "2026-10-20T08:15:00Z",
    "open": 1
  },
  "created_at": "2026-09-02T10:00:00Z",
  "customer_no": "10442",
  "email": "kari@example.no",
  "external_ids": {
    "shop": "C-1042"
  },
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "name": "Kari Kunde",
  "organization_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
  "organization_name": "Fliser AS",
  "phone": "+4790000000",
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such contact or company, or a company named in the body does not exist

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

PATCH /v1/contacts/{contact_id}

Change a contact

Change the fields you send; the rest are not touched. external_ids is merged key by key (a system's id is set, or forgotten with null). Giving the contact an email address, phone number or external id that another contact holds is 409 contact_exists with that contact's id, and nothing is changed.

Parameters

Request body application/json: CustomerPatchIn

{
  "external_ids": {
    "shop": "C-2000"
  },
  "organization_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
  "phone": "+47 911 22 333"
}

200 Successful Response

Body application/json: Customer

{
  "case_counts": {
    "cases": 3,
    "last_contact_at": "2026-10-20T08:15:00Z",
    "open": 1
  },
  "created_at": "2026-09-02T10:00:00Z",
  "customer_no": "10442",
  "email": "kari@example.no",
  "external_ids": {
    "shop": "C-1042"
  },
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "name": "Kari Kunde",
  "organization_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
  "organization_name": "Fliser AS",
  "phone": "+4790000000",
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such contact or company, or a company named in the body does not exist

Body application/json: ErrorResponse

409 The email, phone number or external id is held by another, or the name is taken; `details` names the existing one

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/contacts/{contact_id}/cases

List a contact's cases

The cases this person is the customer of, newest first, in the same shape as GET /v1/cases. It needs the scope cases:read besides contacts:read, and a case in a group the key does not see is not listed.

Parameters

200 Successful Response

Body application/json: CaseList

{
  "items": [
    {
      "channel": "api",
      "contact": {
        "email": "kari@example.no",
        "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
        "language": "nb",
        "name": "Kari Kunde"
      },
      "created_at": "2026-11-09T09:00:00Z",
      "custom_fields": {},
      "external_ref": "order-12345",
      "group_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "last_message_at": "2026-11-09T09:00:00Z",
      "number": 1042,
      "priority": "normal",
      "source": "Returns page",
      "status": "new",
      "subject": "Cracked tiles in the delivery",
      "tags": [
        "delivery"
      ],
      "updated_at": "2026-11-09T09:00:00Z",
      "version": 1
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such contact or company, or a company named in the body does not exist

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/organizations

List or find companies

The workspace's companies, by name, a page at a time. external_system with external_id finds the one you know by its id in your own system.

Parameters

200 Successful Response

Body application/json: OrganizationList

{
  "items": [
    {
      "case_counts": {
        "cases": 9,
        "last_contact_at": "2026-10-20T08:15:00Z",
        "open": 2
      },
      "created_at": "2026-09-02T10:00:00Z",
      "domains": [
        "fliser.no"
      ],
      "external_ids": {
        "crm": "ORG-77"
      },
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
      "name": "Fliser AS",
      "people": 4,
      "updated_at": "2026-10-20T08:15:00Z"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/organizations

Create a company

Make a company. One with the same name, or the same id in external_ids, is not made twice: nothing is written and the answer is 409 organization_exists with the existing company's id in details.organization_id. Send an Idempotency-Key so that a retry makes nothing twice.

Parameters

Request body application/json: OrganizationIn

{
  "domains": [
    "fliser.no"
  ],
  "external_ids": {
    "crm": "ORG-77"
  },
  "name": "Fliser AS"
}

201 Successful Response

Body application/json: Organization

{
  "case_counts": {
    "cases": 9,
    "last_contact_at": "2026-10-20T08:15:00Z",
    "open": 2
  },
  "created_at": "2026-09-02T10:00:00Z",
  "domains": [
    "fliser.no"
  ],
  "external_ids": {
    "crm": "ORG-77"
  },
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
  "name": "Fliser AS",
  "people": 4,
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

409 The email, phone number or external id is held by another, or the name is taken; `details` names the existing one

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/organizations/{organization_id}

Get a company

One company by id, with how many people belong to it and the counts of its cases the key sees.

Parameters

200 Successful Response

Body application/json: Organization

{
  "case_counts": {
    "cases": 9,
    "last_contact_at": "2026-10-20T08:15:00Z",
    "open": 2
  },
  "created_at": "2026-09-02T10:00:00Z",
  "domains": [
    "fliser.no"
  ],
  "external_ids": {
    "crm": "ORG-77"
  },
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
  "name": "Fliser AS",
  "people": 4,
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such contact or company, or a company named in the body does not exist

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

PATCH /v1/organizations/{organization_id}

Change a company

Change the fields you send; the rest are not touched. domains replaces the list; external_ids is merged key by key. A name or an external id that another company has is 409 organization_exists with that company's id, and nothing is changed.

Parameters

Request body application/json: OrganizationPatchIn

{
  "domains": [
    "fliser.no",
    "fliser.com"
  ],
  "external_ids": {}
}

200 Successful Response

Body application/json: Organization

{
  "case_counts": {
    "cases": 9,
    "last_contact_at": "2026-10-20T08:15:00Z",
    "open": 2
  },
  "created_at": "2026-09-02T10:00:00Z",
  "domains": [
    "fliser.no"
  ],
  "external_ids": {
    "crm": "ORG-77"
  },
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
  "name": "Fliser AS",
  "people": 4,
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such contact or company, or a company named in the body does not exist

Body application/json: ErrorResponse

409 The email, phone number or external id is held by another, or the name is taken; `details` names the existing one

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/organizations/{organization_id}/contacts

List a company's contacts

The people who belong to the company, by name, a page at a time, in the shape of GET /v1/contacts.

Parameters

200 Successful Response

Body application/json: CustomerList

{
  "items": [
    {
      "case_counts": {
        "cases": 3,
        "last_contact_at": "2026-10-20T08:15:00Z",
        "open": 1
      },
      "created_at": "2026-09-02T10:00:00Z",
      "customer_no": "10442",
      "email": "kari@example.no",
      "external_ids": {
        "shop": "C-1042"
      },
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "language": "nb",
      "name": "Kari Kunde",
      "organization_id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f9",
      "organization_name": "Fliser AS",
      "phone": "+4790000000",
      "updated_at": "2026-10-20T08:15:00Z"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such contact or company, or a company named in the body does not exist

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/articles

List or search articles

The workspace's articles, newest first, a page at a time. q is the search the app's Knowledge page uses: it matches words, not meaning, and a request never calls a model. An article an import has retired is not listed.

Parameters

200 Successful Response

Body application/json: ArticleList

{
  "items": [
    {
      "audience": "public",
      "created_at": "2026-10-20T08:00:00Z",
      "excerpt": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "language": "nb",
      "origin": "written",
      "published_at": "2026-10-20T08:15:00Z",
      "status": "published",
      "title": "Returfrist for fliser",
      "topics": [
        "return"
      ],
      "updated_at": "2026-10-20T08:15:00Z"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/articles

Create an article

Write an article. It is a draft and internal unless you say otherwise, and it is indexed for search as soon as it is saved, exactly as one written in the app is. The key is named in the workspace's audit log.

Send an Idempotency-Key so that a retry writes one article.

Parameters

Request body application/json: ArticleIn

{
  "audience": "public",
  "body": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "language": "nb",
  "status": "published",
  "title": "Returfrist for fliser",
  "topics": [
    "return"
  ]
}

201 Successful Response

Body application/json: Article

{
  "audience": "public",
  "body": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "created_at": "2026-10-20T08:00:00Z",
  "excerpt": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "origin": "written",
  "published_at": "2026-10-20T08:15:00Z",
  "status": "published",
  "title": "Returfrist for fliser",
  "topics": [
    "return"
  ],
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/articles/{article_id}

Get an article

One article with its text. An id from another workspace, or of an imported page the site no longer has, is a 404.

Parameters

200 Successful Response

Body application/json: Article

{
  "audience": "public",
  "body": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "created_at": "2026-10-20T08:00:00Z",
  "excerpt": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "origin": "written",
  "published_at": "2026-10-20T08:15:00Z",
  "status": "published",
  "title": "Returfrist for fliser",
  "topics": [
    "return"
  ],
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such article

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

PATCH /v1/articles/{article_id}

Change an article

Change what you send: title, text, language, brand, audience or topics. A change to the title or text is indexed again. Whether it is published is publish and unpublish.

Parameters

Request body application/json: ArticlePatch

{
  "audience": "public",
  "body": "Returfristen er 60 dager."
}

200 Successful Response

Body application/json: Article

{
  "audience": "public",
  "body": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "created_at": "2026-10-20T08:00:00Z",
  "excerpt": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "origin": "written",
  "published_at": "2026-10-20T08:15:00Z",
  "status": "published",
  "title": "Returfrist for fliser",
  "topics": [
    "return"
  ],
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such article

Body application/json: ErrorResponse

422 The request did not validate

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/articles/{article_id}/publish

Publish an article

Make a draft usable: the team can insert it, and the bot can answer from it if its audience is public. Publishing a published article changes nothing.

Parameters

200 Successful Response

Body application/json: Article

{
  "audience": "public",
  "body": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "created_at": "2026-10-20T08:00:00Z",
  "excerpt": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "origin": "written",
  "published_at": "2026-10-20T08:15:00Z",
  "status": "published",
  "title": "Returfrist for fliser",
  "topics": [
    "return"
  ],
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such article

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/articles/{article_id}/unpublish

Unpublish an article

Take an article out of use: it becomes a draft again, and neither the team's search nor the bot finds it. Nothing is deleted, and publishing it again brings it back.

Parameters

200 Successful Response

Body application/json: Article

{
  "audience": "public",
  "body": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "created_at": "2026-10-20T08:00:00Z",
  "excerpt": "Returfristen er 30 dager. Send varene uåpnet i retur sammen med kvitteringen.",
  "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
  "language": "nb",
  "origin": "written",
  "published_at": "2026-10-20T08:15:00Z",
  "status": "published",
  "title": "Returfrist for fliser",
  "topics": [
    "return"
  ],
  "updated_at": "2026-10-20T08:15:00Z"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope

Body application/json: ErrorResponse

404 No such article

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/webhook-endpoints

List webhook endpoints

The endpoints this key could have made: all of the workspace's when the key sees every group, otherwise those that hear only groups the key sees.

200 Successful Response

Body application/json: WebhookEndpointList

{
  "items": [
    {
      "all_groups": false,
      "created_at": "2026-11-09T12:00:00Z",
      "enabled": true,
      "events": [
        "case.created",
        "case.updated",
        "case.message.created"
      ],
      "group_ids": [
        "0b1c1f0e-8f6e-4d8e-9a47-0c8f5d0e6a11"
      ],
      "id": "0192f3a4-1111-7e2d-a3f4-5b6c7d8e9f01",
      "last_success_at": "2026-11-10T08:20:42Z",
      "name": "Returns page",
      "url": "https://returns.example.com/hooks/nolmo"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/webhook-endpoints

Make a webhook endpoint

Nolmo sends the chosen events to url as signed POSTs (see the webhooks section for the body and the signature). The address must be https and public; it is checked now and on every send. The answer holds the signing secret: it is shown only here.

An endpoint hears only the cases a key with its groups could read. A key can give only the groups it sees itself; all_groups needs a key that sees every group.

Parameters

Request body application/json: WebhookEndpointCreate

{
  "all_groups": false,
  "events": [
    "case.created",
    "case.updated",
    "case.message.created"
  ],
  "group_ids": [
    "0b1c1f0e-8f6e-4d8e-9a47-0c8f5d0e6a11"
  ],
  "name": "Returns page",
  "url": "https://returns.example.com/hooks/nolmo"
}

201 Successful Response

Body application/json: WebhookEndpointCreated

{
  "all_groups": false,
  "created_at": "2026-11-09T12:00:00Z",
  "enabled": true,
  "events": [
    "case.created",
    "case.updated",
    "case.message.created"
  ],
  "group_ids": [
    "0b1c1f0e-8f6e-4d8e-9a47-0c8f5d0e6a11"
  ],
  "id": "0192f3a4-1111-7e2d-a3f4-5b6c7d8e9f01",
  "last_success_at": "2026-11-10T08:20:42Z",
  "name": "Returns page",
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw9o7cXx1b0hE=",
  "url": "https://returns.example.com/hooks/nolmo"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/webhook-endpoints/{endpoint_id}

Read a webhook endpoint

The endpoint's address, events, groups and state. The secret is never returned.

Parameters

200 Successful Response

Body application/json: WebhookEndpoint

{
  "all_groups": false,
  "created_at": "2026-11-09T12:00:00Z",
  "enabled": true,
  "events": [
    "case.created",
    "case.updated",
    "case.message.created"
  ],
  "group_ids": [
    "0b1c1f0e-8f6e-4d8e-9a47-0c8f5d0e6a11"
  ],
  "id": "0192f3a4-1111-7e2d-a3f4-5b6c7d8e9f01",
  "last_success_at": "2026-11-10T08:20:42Z",
  "name": "Returns page",
  "url": "https://returns.example.com/hooks/nolmo"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

PATCH /v1/webhook-endpoints/{endpoint_id}

Change a webhook endpoint

Only what is sent changes. enabled: true turns a stopped endpoint on again and sends what waited, as long as it is within 24 hours.

Parameters

Request body application/json: WebhookEndpointUpdate

{
  "enabled": false
}

200 Successful Response

Body application/json: WebhookEndpoint

{
  "all_groups": false,
  "created_at": "2026-11-09T12:00:00Z",
  "enabled": true,
  "events": [
    "case.created",
    "case.updated",
    "case.message.created"
  ],
  "group_ids": [
    "0b1c1f0e-8f6e-4d8e-9a47-0c8f5d0e6a11"
  ],
  "id": "0192f3a4-1111-7e2d-a3f4-5b6c7d8e9f01",
  "last_success_at": "2026-11-10T08:20:42Z",
  "name": "Returns page",
  "url": "https://returns.example.com/hooks/nolmo"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

DELETE /v1/webhook-endpoints/{endpoint_id}

Delete a webhook endpoint

The endpoint and its delivery log are gone, and nothing more is sent to it.

Parameters

204 Successful Response

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/webhook-endpoints/{endpoint_id}/rotate-secret

Rotate an endpoint's secret

A new secret, shown only in this answer. The old one keeps signing for 24 hours beside it (webhook-signature then holds both), so the receiver can change over without a gap.

Parameters

200 Successful Response

Body application/json: WebhookEndpointCreated

{
  "all_groups": false,
  "created_at": "2026-11-09T12:00:00Z",
  "enabled": true,
  "events": [
    "case.created",
    "case.updated",
    "case.message.created"
  ],
  "group_ids": [
    "0b1c1f0e-8f6e-4d8e-9a47-0c8f5d0e6a11"
  ],
  "id": "0192f3a4-1111-7e2d-a3f4-5b6c7d8e9f01",
  "last_success_at": "2026-11-10T08:20:42Z",
  "name": "Returns page",
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw9o7cXx1b0hE=",
  "url": "https://returns.example.com/hooks/nolmo"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/webhook-endpoints/{endpoint_id}/deliveries

The delivery log

What was sent to the endpoint in the last 30 days, newest first: the event, how many attempts, the receiver's last status code. Page with cursor.

Parameters

200 Successful Response

Body application/json: WebhookDeliveryList

{
  "items": [
    {
      "attempts": 1,
      "case_number": 1042,
      "delivered_at": "2026-11-10T08:20:42Z",
      "event": "case.message.created",
      "id": "0192f3a4-2222-7e2d-a3f4-5b6c7d8e9f01",
      "last_attempt_at": "2026-11-10T08:20:42Z",
      "occurred_at": "2026-11-10T08:20:41Z",
      "response_code": 200,
      "status": "delivered"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/resend

Send one event again

The same event with the same webhook-id, as a new series of attempts. The receiver dedupes by that id.

Parameters

200 Successful Response

Body application/json: WebhookDelivery

{
  "attempts": 1,
  "case_number": 1042,
  "delivered_at": "2026-11-10T08:20:42Z",
  "event": "case.message.created",
  "id": "0192f3a4-2222-7e2d-a3f4-5b6c7d8e9f01",
  "last_attempt_at": "2026-11-10T08:20:42Z",
  "occurred_at": "2026-11-10T08:20:41Z",
  "response_code": 200,
  "status": "delivered"
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST /v1/webhook-endpoints/{endpoint_id}/replay

Send everything since a time again

Every event in the log since since, delivered or not, again and in order, each with its own webhook-id. For a receiver that was down for longer than the 24 hours events are retried. Only the last 30 days are kept.

Parameters

Request body application/json: Replay

{
  "since": "2026-11-10T08:00:00Z"
}

200 Successful Response

Body application/json: Replayed

{
  "queued": 12
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `webhooks:manage`, or the groups

Body application/json: ErrorResponse

404 No such endpoint, or one the key could not have made

Body application/json: ErrorResponse

409 The endpoint is off, or the workspace is at its limit

Body application/json: ErrorResponse

422 Not accepted, e.g. `webhook_url_refused` (see `details.reason`)

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/groups

List groups

The workspace's groups, by name. A key limited to some groups sees those only. Use an id as group_id when creating a case or searching.

200 Successful Response

Body application/json: GroupList

{
  "items": [
    {
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6",
      "name": "Support"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/agents

List the team

The people who work in the workspace: an id, a first name and the groups they are in. No surname, email or phone number is shared. Use an id as assignee_id when searching.

A key limited to some groups sees the people who are in one of them, and only which of the key's groups they are in.

200 Successful Response

Body application/json: AgentList

{
  "items": [
    {
      "first_name": "Astrid",
      "group_ids": [
        "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6"
      ],
      "id": "0192f3c4-6a1b-7c2d-8e3f-a1b2c3d4e5f6"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/case-types

List case types

The workspace's case types: what type takes when you create a case, and what type filters on in a search. Only the ones in use.

200 Successful Response

Body application/json: CaseTypeList

{
  "items": [
    {
      "key": "return",
      "name": "Return"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/case-fields

List case fields

The workspace's own fields on a case: the key to use in custom_fields, what it is called, its kind, and for a select its choices.

200 Successful Response

Body application/json: CaseFieldList

{
  "items": [
    {
      "key": "order_no",
      "kind": "text",
      "label": "Order number",
      "options": []
    },
    {
      "key": "carrier",
      "kind": "select",
      "label": "Carrier",
      "options": [
        {
          "label": "Posten",
          "value": "posten"
        },
        {
          "label": "DHL",
          "value": "dhl"
        }
      ]
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

GET /v1/tags

List tags

The tags on the cases the key sees, with how many cases have each, the most used first. A key limited to some groups counts its own cases only.

200 Successful Response

Body application/json: TagList

{
  "items": [
    {
      "count": 12,
      "tag": "delivery"
    }
  ]
}

401 No key, or a key that is wrong, revoked or expired

Body application/json: ErrorResponse

403 The key lacks the scope `cases:read`

Body application/json: ErrorResponse

429 Over the limit; see `Retry-After`

Body application/json: ErrorResponse

POST case.created

case.created

A case was made.

Nolmo sends a POST with a JSON body and these headers:

• webhook-id: this event's id, the same on every retry and replay. Dedupe by it.
• webhook-timestamp: seconds since the epoch, when this attempt was made.
• webhook-signature: v1,<base64> for each valid secret, space separated. The signature is HMAC-SHA256 over <webhook-id>.<webhook-timestamp>.<body> with the secret's bytes (the base64 after whsec_), as in Standard Webhooks. Refuse a timestamp more than five minutes from your clock and a body whose signature does not match.

Answer with any 2xx within ten seconds. Anything else, or no answer, is retried with a growing pause for 24 hours; events of one case arrive in order. An endpoint that answers nothing for three days is turned off and the workspace's admins are told. Redirects are not followed.

import base64, hashlib, hmac, time

def verify(secret: str, headers: dict, body: bytes, tolerance: int = 300) -> bool:
    """True when `body` was signed with `secret` (the whsec_ value) and is fresh."""
    msg_id = headers["webhook-id"]
    timestamp = headers["webhook-timestamp"]
    if abs(time.time() - int(timestamp)) > tolerance:
        return False
    key = base64.b64decode(secret.removeprefix("whsec_"))
    signed = f"{msg_id}.{timestamp}.".encode() + body
    expected = base64.b64encode(hmac.new(key, signed, hashlib.sha256).digest()).decode()
    return any(
        hmac.compare_digest(expected, part.removeprefix("v1,"))
        for part in headers["webhook-signature"].split()
        if part.startswith("v1,")
    )

Request body application/json: CaseCreatedEvent

{
  "created_at": "2026-11-10T08:15:00Z",
  "data": {
    "case": {
      "assignee": "Astrid",
      "channel": "email",
      "contact": {
        "email": "kari@example.com",
        "id": "7c2e4a1b-9d3f-4f6a-8b5e-1a2b3c4d5e6f",
        "name": "Kari Kunde"
      },
      "created_at": "2026-11-10T08:15:00Z",
      "id": "5d0b8f0e-2a4c-7d3e-9c1a-3b6f2e8a1c42",
      "number": 1042,
      "priority": "high",
      "status": "open",
      "subject": "Cracked tile in the delivery",
      "tags": [
        "delivery",
        "tiles"
      ],
      "type": "complaint",
      "updated_at": "2026-11-10T08:20:41Z"
    }
  },
  "id": "0192f3a4-3333-7e2d-a3f4-5b6c7d8e9f01",
  "type": "case.created"
}

200 Successful Response

Body application/json: any

POST case.updated

case.updated

A case's status, assignee, priority or type changed (one event per change).

Nolmo sends a POST with a JSON body and these headers:

• webhook-id: this event's id, the same on every retry and replay. Dedupe by it.
• webhook-timestamp: seconds since the epoch, when this attempt was made.
• webhook-signature: v1,<base64> for each valid secret, space separated. The signature is HMAC-SHA256 over <webhook-id>.<webhook-timestamp>.<body> with the secret's bytes (the base64 after whsec_), as in Standard Webhooks. Refuse a timestamp more than five minutes from your clock and a body whose signature does not match.

Answer with any 2xx within ten seconds. Anything else, or no answer, is retried with a growing pause for 24 hours; events of one case arrive in order. An endpoint that answers nothing for three days is turned off and the workspace's admins are told. Redirects are not followed.

import base64, hashlib, hmac, time

def verify(secret: str, headers: dict, body: bytes, tolerance: int = 300) -> bool:
    """True when `body` was signed with `secret` (the whsec_ value) and is fresh."""
    msg_id = headers["webhook-id"]
    timestamp = headers["webhook-timestamp"]
    if abs(time.time() - int(timestamp)) > tolerance:
        return False
    key = base64.b64decode(secret.removeprefix("whsec_"))
    signed = f"{msg_id}.{timestamp}.".encode() + body
    expected = base64.b64encode(hmac.new(key, signed, hashlib.sha256).digest()).decode()
    return any(
        hmac.compare_digest(expected, part.removeprefix("v1,"))
        for part in headers["webhook-signature"].split()
        if part.startswith("v1,")
    )

Request body application/json: CaseUpdatedEvent

{
  "created_at": "2026-11-10T08:18:00Z",
  "data": {
    "case": {
      "assignee": "Astrid",
      "channel": "email",
      "contact": {
        "email": "kari@example.com",
        "id": "7c2e4a1b-9d3f-4f6a-8b5e-1a2b3c4d5e6f",
        "name": "Kari Kunde"
      },
      "created_at": "2026-11-10T08:15:00Z",
      "id": "5d0b8f0e-2a4c-7d3e-9c1a-3b6f2e8a1c42",
      "number": 1042,
      "priority": "high",
      "status": "open",
      "subject": "Cracked tile in the delivery",
      "tags": [
        "delivery",
        "tiles"
      ],
      "type": "complaint",
      "updated_at": "2026-11-10T08:20:41Z"
    },
    "changes": [
      {
        "field": "assignee",
        "to": "Astrid"
      }
    ]
  },
  "id": "0192f3a4-4444-7e2d-a3f4-5b6c7d8e9f01",
  "type": "case.updated"
}

200 Successful Response

Body application/json: any

POST case.message.created

case.message.created

A reply the customer sees was added to a case.

Nolmo sends a POST with a JSON body and these headers:

• webhook-id: this event's id, the same on every retry and replay. Dedupe by it.
• webhook-timestamp: seconds since the epoch, when this attempt was made.
• webhook-signature: v1,<base64> for each valid secret, space separated. The signature is HMAC-SHA256 over <webhook-id>.<webhook-timestamp>.<body> with the secret's bytes (the base64 after whsec_), as in Standard Webhooks. Refuse a timestamp more than five minutes from your clock and a body whose signature does not match.

Answer with any 2xx within ten seconds. Anything else, or no answer, is retried with a growing pause for 24 hours; events of one case arrive in order. An endpoint that answers nothing for three days is turned off and the workspace's admins are told. Redirects are not followed.

import base64, hashlib, hmac, time

def verify(secret: str, headers: dict, body: bytes, tolerance: int = 300) -> bool:
    """True when `body` was signed with `secret` (the whsec_ value) and is fresh."""
    msg_id = headers["webhook-id"]
    timestamp = headers["webhook-timestamp"]
    if abs(time.time() - int(timestamp)) > tolerance:
        return False
    key = base64.b64decode(secret.removeprefix("whsec_"))
    signed = f"{msg_id}.{timestamp}.".encode() + body
    expected = base64.b64encode(hmac.new(key, signed, hashlib.sha256).digest()).decode()
    return any(
        hmac.compare_digest(expected, part.removeprefix("v1,"))
        for part in headers["webhook-signature"].split()
        if part.startswith("v1,")
    )

Request body application/json: CaseMessageCreatedEvent

{
  "created_at": "2026-11-10T08:20:41Z",
  "data": {
    "case": {
      "assignee": "Astrid",
      "channel": "email",
      "contact": {
        "email": "kari@example.com",
        "id": "7c2e4a1b-9d3f-4f6a-8b5e-1a2b3c4d5e6f",
        "name": "Kari Kunde"
      },
      "created_at": "2026-11-10T08:15:00Z",
      "id": "5d0b8f0e-2a4c-7d3e-9c1a-3b6f2e8a1c42",
      "number": 1042,
      "priority": "high",
      "status": "open",
      "subject": "Cracked tile in the delivery",
      "tags": [
        "delivery",
        "tiles"
      ],
      "type": "complaint",
      "updated_at": "2026-11-10T08:20:41Z"
    },
    "message": {
      "author_kind": "customer",
      "created_at": "2026-11-10T08:20:41Z",
      "id": "0192f3a4-7b1c-7e2d-a3f4-5b6c7d8e9f01",
      "kind": "public",
      "text": "Hi, three of the tiles in the pallet were cracked."
    }
  },
  "id": "0192f3a4-5555-7e2d-a3f4-5b6c7d8e9f01",
  "type": "case.message.created"
}

200 Successful Response

Body application/json: any

POST case.note.created

case.note.created

An internal note was added to a case. Only sent to an endpoint that asks for it.

Nolmo sends a POST with a JSON body and these headers:

• webhook-id: this event's id, the same on every retry and replay. Dedupe by it.
• webhook-timestamp: seconds since the epoch, when this attempt was made.
• webhook-signature: v1,<base64> for each valid secret, space separated. The signature is HMAC-SHA256 over <webhook-id>.<webhook-timestamp>.<body> with the secret's bytes (the base64 after whsec_), as in Standard Webhooks. Refuse a timestamp more than five minutes from your clock and a body whose signature does not match.

Answer with any 2xx within ten seconds. Anything else, or no answer, is retried with a growing pause for 24 hours; events of one case arrive in order. An endpoint that answers nothing for three days is turned off and the workspace's admins are told. Redirects are not followed.

import base64, hashlib, hmac, time

def verify(secret: str, headers: dict, body: bytes, tolerance: int = 300) -> bool:
    """True when `body` was signed with `secret` (the whsec_ value) and is fresh."""
    msg_id = headers["webhook-id"]
    timestamp = headers["webhook-timestamp"]
    if abs(time.time() - int(timestamp)) > tolerance:
        return False
    key = base64.b64decode(secret.removeprefix("whsec_"))
    signed = f"{msg_id}.{timestamp}.".encode() + body
    expected = base64.b64encode(hmac.new(key, signed, hashlib.sha256).digest()).decode()
    return any(
        hmac.compare_digest(expected, part.removeprefix("v1,"))
        for part in headers["webhook-signature"].split()
        if part.startswith("v1,")
    )

Request body application/json: CaseNoteCreatedEvent

{
  "created_at": "2026-11-10T08:22:00Z",
  "data": {
    "case": {
      "assignee": "Astrid",
      "channel": "email",
      "contact": {
        "email": "kari@example.com",
        "id": "7c2e4a1b-9d3f-4f6a-8b5e-1a2b3c4d5e6f",
        "name": "Kari Kunde"
      },
      "created_at": "2026-11-10T08:15:00Z",
      "id": "5d0b8f0e-2a4c-7d3e-9c1a-3b6f2e8a1c42",
      "number": 1042,
      "priority": "high",
      "status": "open",
      "subject": "Cracked tile in the delivery",
      "tags": [
        "delivery",
        "tiles"
      ],
      "type": "complaint",
      "updated_at": "2026-11-10T08:20:41Z"
    },
    "message": {
      "author_kind": "team",
      "created_at": "2026-11-10T08:20:41Z",
      "id": "0192f3a4-7b1c-7e2d-a3f4-5b6c7d8e9f01",
      "kind": "internal",
      "text": "Replacement tiles ordered."
    }
  },
  "id": "0192f3a4-6666-7e2d-a3f4-5b6c7d8e9f01",
  "type": "case.note.created"
}

200 Successful Response

Body application/json: any