Skip to main content
GET
List cases

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

status
enum<string>
default:open

Case status. Defaults to open; use all to include every status.

Available options:
open,
completed,
closed,
all
blocked_on
enum<string>

Filter by an open blocker party kind, any open blocker, or no open blocker.

Available options:
external,
customer,
internal,
any,
none
stalled_days
integer

Return cases blocked for at least this many whole days (1–365).

Required range: 1 <= x <= 365
due_check_in
boolean

When true, return cases whose check-in is due.

q
string

Case title substring, at most 100 characters.

Maximum string length: 100
page
integer
default:1

Page number, starting at 1. Lists contain up to 25 rows.

Required range: x >= 1

Response

Success

payload
object[]
required

Payload for this response.

meta
object
required

Meta for this response.