Search Agreements

GET /public/action/agreements/search

Lists agreements in the workspace, optionally filtered to a single client. Read-only — agreements cannot be created or updated through the public API.

Authentication: X-API-KEY header (see Authentication).

Query parameters

Parameter	Type	Required	Description
id	string	No	Exact agreement id. When provided, returns just that agreement (ignores clientId).
clientId	string	No	Return only agreements for this client. Omit to list all agreements in the workspace.

Request

curl "https://api.withmoxie.com/public/action/agreements/search?clientId=66b0f2a1c3a9e40012ab34cd" \
  -H "X-API-KEY: your_api_key_here"

Response

Returns an array of AgreementMini objects.

[
  {
    "id": "66b1a0f0c3a9e40012abaa01",
    "accountId": 10016,
    "name": "Master Services Agreement",
    "client": { "id": "66b0f2a1c3a9e40012ab34cd", "name": "Acme Kft." },
    "account": { "accountId": 10016, "accountName": "Moxie" },
    "status": "FINALIZED",
    "statusTime": "2026-06-02T10:15:00Z",
    "currency": "HUF",
    "dateCreated": "2026-05-28T09:00:00Z",
    "dateCompleted": "2026-06-02T10:15:00Z",
    "fullyExecuted": true,
    "userSigned": true,
    "clientSigned": true
  }
]

Agreement status values

DRAFT, FINALIZED, DECLINED, VOID, ARCHIVED