List all Cases | Persona

Help Center OpenAPI Spec Status

Documentation API Reference Changelog Integration Guides

Getting Started
- Introduction
- Quickstart Tutorial
API Overview
Versioning
- API Changelog
- Versioning
Troubleshooting
- Error Handling
API Reference

Help Center OpenAPI Spec Status

GET

https://withpersona.com/api/v1/cases

GET

/api/v1/cases

1 curl https://withpersona.com/api/v1/cases \
2      -H "Authorization: <apiKey>"

Try it

1 {
2   "data": [
3     {
4       "type": "case",
5       "id": "case_KsFU1Vxv9oK3ztnwQuD7MaJo",
6       "attributes": {
7         "status": "open",
8         "name": "KCAS-1",
9         "resolution": {},
10         "created-at": "2021-03-24T04:59:21.764Z",
11         "updated-at": "2021-03-24T04:59:21.764Z",
12         "assigned-at": {},
13         "creator-id": {},
14         "creator-type": {},
15         "assignee-id": {},
16         "resolver-id": {},
17         "resolver-type": {},
18         "updater-id": {},
19         "updater-type": {},
20         "tags": []
21       },
22       "relationships": {
23         "case-template": {
24           "data": {
25             "type": "case-template",
26             "id": "ctmpl_336jV1uVaaY84GAqvG91oiy9"
27           }
28         }
29       }
30     }
31   ],
32   "links": {
33     "prev": {},
34     "next": {}
35   }
36 }

Was this page helpful?

Returns a list of your organization's cases. Note that this endpoint aggregates cases across all <<glossary:case template>>(s). See [Pagination](ref:fill-pagination) for more details about handling the response.

List all Cases

Authentication

Authorizationstring

API Key authentication via header

Headers

key-inflectionstringOptional

Determines casing for the API response

Query Parameters

page[after]stringOptional

Case ID for pagination cursor

page[before]stringOptional

Case ID for pagination cursor

page[size]stringOptional

Limit on the number of cases returned

filter[status]stringOptional

Filter cases by status

filter[resolution]stringOptional

Filter cases by resolution

filter[case-template-id]stringOptional

Filter cases by case template ID

filter[account-id]stringOptional

Filter cases by account ID

filter[inquiry-id]stringOptional

Filter cases by inquiry ID

filter[report-id]stringOptional

Filter cases by report ID

Response

200

datalist of objects or null

linksobject or null

Errors

Case ID for pagination cursor

Limit on the number of cases returned

Filter cases by status

Filter cases by resolution

Filter cases by case template ID

Filter cases by account ID

Filter cases by inquiry ID

Filter cases by report ID

Returns a list of your organization’s cases.

Note that this endpoint aggregates cases across all <<glossary:case template>>(s). See Pagination for more details about handling the response.

1	curl https://withpersona.com/api/v1/cases \
2	-H "Authorization: <apiKey>"

1	{
2	"data": [
3	{
4	"type": "case",
5	"id": "case_KsFU1Vxv9oK3ztnwQuD7MaJo",
6	"attributes": {
7	"status": "open",
8	"name": "KCAS-1",
9	"resolution": {},
10	"created-at": "2021-03-24T04:59:21.764Z",
11	"updated-at": "2021-03-24T04:59:21.764Z",
12	"assigned-at": {},
13	"creator-id": {},
14	"creator-type": {},
15	"assignee-id": {},
16	"resolver-id": {},
17	"resolver-type": {},
18	"updater-id": {},
19	"updater-type": {},
20	"tags": []
21	},
22	"relationships": {
23	"case-template": {
24	"data": {
25	"type": "case-template",
26	"id": "ctmpl_336jV1uVaaY84GAqvG91oiy9"
27	}
28	}
29	}
30	}
31	],
32	"links": {
33	"prev": {},
34	"next": {}
35	}
36	}