GetCases

post

https://{yourlidiaurl}/case/query/cases

Retrieves or queries Query records based on the specified criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

caseIds

array | null

caseIds

ownerIds

array | null

ownerIds

codes

array of strings | null

Gets or sets the Codes.

codes

integrationCodes

array of strings | null

integrationCodes

refNumbers

array of strings | null

Gets or sets the RefNumbers.

refNumbers

subjectIds

array | null

subjectIds

channels

array of strings | null

Gets or sets the Channels.

channels

priorities

array of strings | null

Gets or sets the Priorities.

priorities

caseStates

array of objects | null

Gets or sets the CaseStates.

caseStates

subjectTypes

array of objects | null

Gets or sets the SubjectTypes.

subjectTypes

includeCasePropertiesWithAnd

array of objects | null

includeCasePropertiesWithAnd

environment

string | null

Gets or sets the deployment environment identifier.

applicationIP

string | null

Gets or sets the IP address of the initiating application.

tenantId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the tenant identifier for data isolation.

userToken

string | null

Gets or sets the authorization token representing the active user session.

sessionId

string | null

Gets or sets the active session identifier.

userId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the unique numeric identifier of the user.

userIP

string | null

Gets or sets the IP address of the end user.

envelope

string | null

Gets or sets the request envelope information.

threadId

string | null

Gets or sets the thread execution tracker key.

includes

array of strings | null

Gets or sets the list of navigation properties to eagerly load.

includes

searchKey

string | null

Gets or sets the search term used for text-based filtering.

fromDate

date-time | null

Gets or sets the starting date filter boundary.

toDate

date-time | null

Gets or sets the ending date filter boundary.

pageIndex

string

^-?(?:0|[1-9]\d*)$

Gets or sets the 0-based page index.

pageSize

string

^-?(?:0|[1-9]\d*)$

Gets or sets the size of the request page.

sorting

string | null

Gets or sets the sort configuration string (e.g. FieldName ASC/DESC).

status

array of objects | null

Gets or sets the list of entity status filters to apply.

status

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

200

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here!