Count contracts per status in a workspace
Returns the number of contracts in each status for the workspace, optionally filtered by type. Drives the list page status-tab counts (All, Active, Draft) without loading every contract.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/contracts.v1.Contracts/CountContracts" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "AAECAwQFBgcICQoLDA0ODw==" }'{
"counts": [
{
"status": "CONTRACT_STATUS_ACTIVE",
"count": 12
},
{
"status": "CONTRACT_STATUS_DRAFT",
"count": 3
}
]
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}GetWorkspace
Returns the workspace record identified by workspace_id. The caller must be a member of the workspace; requests for workspaces the caller does not belong to are rejected with permission_denied.
GetContract
Returns the contract identified by contract_id within the given workspace. Soft-deleted contracts are not returned.