GET
/v1/workspace/agreements/{kind}Read workspace agreements kind
One agreement addressed by KIND ('msa'), with this workspace's standing against the current version: whether the caller personally accepted it, whether the workspace signed and who signed, and when this version was first and last viewed. The HTML body is present only when the words are held here rather than in the CRM. An unknown kind is a 404. Any seat.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
kindpath · stringrequired
bodyquery · nulloptional
paramsquery · objectoptional
:kindstringoptional
queryquery · objectoptional
Responses
200application/json
the action's answer
{
"data": {
"agreedMinimumFunding": {
"amountMinor": 1,
"period": "string"
},
"bodyHtml": "string",
"bodySource": "string",
"effectiveAt": "string",
"firstViewedAt": "string",
"html": "string",
"kind": "string",
"lastViewedAt": "string",
"minimumFunding": {
"source": "string"
},
"signed": true,
"signedAt": "string",
"signedByAccountId": "",
"signedByWorkspace": true,
"signerName": "string",
"signerTitle": "string",
"title": "string",
"version": "string",
"viewCount": 1,
"workspaceSignedAt": "string",
"workspaceSigner": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired