Sign in
Relationship Intelligence

What we owe

What we owe loads promises we made that are still open. The request asks for promised by us, open and at risk, 200 at a time, and it does not ask for an older page. This workspace has no open promise we made, so the page is empty.

get/v1/commitments

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/commitments
  • Auth: HTTP bearer

Query parameters

directionstring
Example:promised_by_me

promised_by_me, promised_by_them, or mutual. What we owe asks for promised_by_me.

statestring
Example:open,at_risk

Comma-separated register states. What we owe asks for open and at risk.

ownerstring

Owner participant reference. What we owe does not send this.

relationshipIdstring uuid

Restrict to one company. What we owe does not send this.

dueBeforestring date-time

Only commitments due before this instant. What we owe does not send this.

changedSincestring date-time

Only commitments updated at or after this instant. What we owe does not send this.

limitinteger
Example:200

Page size (max 200). What we owe asks for 200.

offsetinteger

How many promises to skip. What we owe does not send this on the first page.

includeCandidatesboolean

Include unconfirmed extractions. What we owe does not send this.

Response

Empty promise page.

hasMoreboolean required

Another promise exists beyond this page.

Example response

{
  "commitments": [
    {
      "acceptance": "internally_confirmed",
      "beneficiaryParticipantRef": "customer:acme",
      "blocker": "Waiting on security review.",
      "completedAt": "2026-07-22T17:00:00Z",
      "confidence": 0.94,
      "counterpartyParticipantRef": "jordan@example.com",
      "currentEventVersion": 3,
      "direction": "promised_by_me",
      "dueAt": "2026-07-22T17:00:00Z",
      "duePhrase": "by Friday",
      "dueTimezone": "America/Los_Angeles",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "ownerParticipantRef": "alex@example.com",
      "sourcePhrase": "I will send it by Friday.",
      "status": "active",
      "text": "Send the security packet.",
      "relationshipId": "9c8dfa9b-a7b2-46ea-982c-622a914c00e5",
      "relationshipName": "Acme",
      "state": "at_risk"
    }
  ]
}

Changes

No operation changes recorded.