Matters
Get matter
Gets one case or deal, including its description.
GET/api/v1/matters/{matter_id}
Authorization
AuthorizationstringheaderrequiredBearer authentication header of the form
Bearer <token>, where <token> is your Sentinel API key. See Authentication.Path parameters
matter_idstringpathrequired≤ 64 charactersThe matter's ID, from List matters.
Response
200 · The matter.
idstringrequiredMatter ID.
typestringrequiredOne of
case dealnumberstringrequiredCase or deal number, e.g.
CASE-2025-0142.titlestringrequiredstatusstring | nullrequiredCase or deal status, as set in Sentinel.
prioritystring | nullrequiredsub_typestring | nullrequiredCase violation type or deal type.
closedbooleanrequiredA closed or archived case, or a closed or terminated deal.
archived_atstring (date-time) | nullrequiredWhen a case was archived. Always null for deals.
created_atstring (date-time)requireddescriptionstring | nullrequiredErrors
| Status | Type | When |
|---|---|---|
401 | authentication_required | Missing, invalid, revoked or expired API key. |
403 | permission_denied | The key's role can't use the API. |
404 | not_found | No such matter, or the caller can't access it. |
429 | rate_limited | More than 120 requests in a minute from one key. Retry after the Retry-After header's seconds. |
See Errors and Rate limits.