Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mossdesk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
List commitments

​
page
integer
default:"1"
Page number
​
per_page
integer
default:"25"
Items per page (max 250)
​
sort
string
Sort field
​
order
string
default:"desc"
Sort order: asc or desc
​
contact_id
string
Filter by contact ID
​
deal_id
string
Filter by deal ID
​
status
string
Filter by status: open or completed
​
overdue
boolean
Show only overdue commitments
GET /api/v1/commitments
Example
curl "https://api.mossdesk.com/api/v1/commitments?status=open&overdue=true" \
  -H "X-API-Key: moss_k_..."

​
Get a commitment

GET /api/v1/commitments/:id

​
Create a commitment

POST /api/v1/commitments
​
contact_id
string
required
Contact ID (UUID)
​
description
string
required
Description of the commitment
​
deal_id
string
Associated deal ID (UUID)
​
due_date
string
Due date (YYYY-MM-DD)
​
status
string
default:"open"
Status: open or completed
Example
curl -X POST https://api.mossdesk.com/api/v1/commitments \
  -H "X-API-Key: moss_k_..." \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "cnt_abc123",
    "description": "Deliver SSO implementation timeline",
    "due_date": "2026-02-15"
  }'

​
Update a commitment

PATCH /api/v1/commitments/:id
​
description
string
Description
​
due_date
string
Due date (YYYY-MM-DD)
​
status
string
Status: open or completed

​
Delete a commitment

DELETE /api/v1/commitments/:id

​
Complete a commitment

Mark a commitment as completed. 
PATCH /api/v1/commitments/:id/complete
No request body required. Returns the updated commitment.