Skip to main content
Fetch Cases
Use view=me to retrieve only cases assigned to the authenticated user, or view=all to retrieve all cases for your business. Pass analytics=true to include a summary of open, overdue, resolved, and closed counts alongside the results.

Authorizations

apiKey
string
header
required
apiSecret
string
header
required

Query Parameters

view
enum<string>
required

me returns only cases assigned to the authenticated user. all returns all cases for the business.

Available options:
me,
all
page
integer
default:1

Page number for pagination.

limit
integer
default:20

Number of cases to return per page.

status
enum<string>

Filter cases by status.

Available options:
open,
in progress,
resolved,
closed,
escalated
priority
enum<string>

Filter cases by priority.

Available options:
low,
medium,
high
sort
enum<string>

Sort order for the results.

Available options:
due date,
priority,
newest

Free-text search across case titles and descriptions.

analytics
enum<string>

When true, includes a summary of case counts and average completion time in the response.

Available options:
true,
false
recordId
string

Filter cases linked to a specific Sigma record ID.

Response

Cases returned successfully

message
string
Example:

"Cases fetched successfully"

data
object