Skip to main content
GET
List / search cases

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Query Parameters

after
string
Minimum string length: 1
limit
integer
default:100
Required range: 1 <= x <= 500
includeDeleted
enum<string>
default:false
Available options:
true,
false
view
enum<string>
Available options:
sync,
full
caseState
string
Required string length: 1 - 100
caseType
string
Required string length: 1 - 100
caseTypeId
Required string length: 1 - 200
attorneyId
string
Required string length: 1 - 200
tag
string
Required string length: 1 - 100
createdAfter
string
createdBefore
string
updatedAfter
string
updatedBefore
string
q
string
Required string length: 2 - 200
organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Response

Success

success
boolean
required
cases
object[]
required

Without filter parameters (and without view=full) this is the shipped minimal sync inventory (SyncInventoryCase). With view=full or any filter it is the full Case serializer.

nextCursor
string | null
required