Skip to content

Type Alias: CaseListQuery ​

ts
type CaseListQuery = object;

Filters of GET /cases. Array filters are sent as repeated parameters (status=open&status=in_review); a single value is accepted for convenience. assignee is me, unassigned or a directory user id.

Properties ​

assignee? ​

ts
optional assignee?: string;

country? ​

ts
optional country?: string;

The subject's country.


dueBefore? ​

ts
optional dueBefore?: Date | string;

limit? ​

ts
optional limit?: number;

offset? ​

ts
optional offset?: number;

order? ​

ts
optional order?: SortOrder;

priority? ​

ts
optional priority?: CasePriority | CasePriority[];

queue? ​

ts
optional queue?: string;

The routing label the run gave the case.


reasonCode? ​

ts
optional reasonCode?: string;

A code of the case's decision.


ts
optional search?: string;

The start of the case id, or the subject's external id or name.


slaState? ​

ts
optional slaState?: CaseSlaState | CaseSlaState[];

sort? ​

ts
optional sort?: CaseSort;

status? ​

ts
optional status?: CaseStatus | CaseStatus[];

subjectId? ​

ts
optional subjectId?: string;

type? ​

ts
optional type?: string;

waiting? ​

ts
optional waiting?: boolean;

Waiting for the applicant (true) or not (false).

Released under the Apache-2.0 License.