Retrieve Case

GET

https://withpersona.com/api/v1/cases/:case-id

GET

/api/v1/cases/:case-id

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

Try it

200Retrieved

1 {
2   "data": {
3     "type": "case",
4     "id": "case_KsFU1Vxv9oK3ztnwQuD7MaJo",
5     "attributes": {
6       "status": "open",
7       "name": "KCAS-1",
8       "resolution": {},
9       "created-at": "2021-03-24T04:59:21.764Z",
10       "updated-at": "2021-03-24T04:59:21.764Z",
11       "assigned-at": {},
12       "creator-id": {},
13       "creator-type": {},
14       "assignee-id": {},
15       "resolver-id": {},
16       "resolver-type": {},
17       "updater-id": {},
18       "updater-type": {},
19       "tags": []
20     },
21     "relationships": {
22       "case-template": {
23         "data": {
24           "type": "case-template",
25           "id": "ctmpl_336jV1uVaaY84GAqvG91oiy9"
26         }
27       },
28       "case-comments": {
29         "data": [
30           {
31             "type": "case-comment",
32             "id": "cscm_yd2urRmjaCWcSSxqTSHvUcsn"
33           }
34         ]
35       },
36       "accounts": {
37         "data": [
38           {
39             "type": "account",
40             "id": "act_RNwaSKFUDTzxUakAEuE2xmhZ"
41           }
42         ]
43       },
44       "inquiries": {
45         "data": [
46           {
47             "type": "inquiry",
48             "id": "inq_b6UPkf7mNC1qBtLXnfaWyUbY"
49           }
50         ]
51       },
52       "reports": {
53         "data": []
54       }
55     }
56   },
57   "included": [
58     {
59       "type": "account",
60       "id": "act_RNwaSKFUDTzxUakAEuE2xmhZ",
61       "attributes": {
62         "reference-id": {},
63         "created-at": "2021-03-24T04:59:06.000Z",
64         "updated-at": "2021-03-24T04:59:06.000Z",
65         "tags": []
66       }
67     },
68     {
69       "type": "inquiry",
70       "id": "inq_b6UPkf7mNC1qBtLXnfaWyUbY",
71       "attributes": {
72         "reference-id": {},
73         "created-at": "2021-03-24T04:59:06.000Z",
74         "tags": [],
75         "status": "created",
76         "note": {},
77         "reviewer": {},
78         "reviewer-type": {},
79         "reviewer-comment": {},
80         "started-at": {},
81         "completed-at": {},
82         "failed-at": {},
83         "decisioned-at": {},
84         "expired-at": {}
85       },
86       "relationships": {
87         "account": {
88           "data": {
89             "type": "account",
90             "id": "act_RNwaSKFUDTzxUakAEuE2xmhZ"
91           }
92         },
93         "template": {
94           "data": {
95             "type": "template",
96             "id": "blu_biqYXr3aNfHuLeXUdJUNFNET"
97           }
98         },
99         "reports": {
100           "data": []
101         },
102         "verifications": {
103           "data": []
104         },
105         "sessions": {
106           "data": []
107         },
108         "documents": {
109           "data": []
110         },
111         "selfies": {
112           "data": []
113         }
114       }
115     },
116     {
117       "type": "case-comment",
118       "id": "cscm_yd2urRmjaCWcSSxqTSHvUcsn",
119       "attributes": {
120         "created-at": "2021-03-25T07:04:16.667Z",
121         "updated-at": "2021-03-25T07:04:16.667Z",
122         "message": "This is a case comment",
123         "commenter-id": "admin@acme.com",
124         "commenter-type": "user"
125       }
126     }
127   ]
128 }

Retrieves the details of a <<glossary:case>> that has previously been created.

Path parameters

case-idstringRequired

Response

200

dataobject or null

includedlist of objects or null

Retrieve Case

Path parameters

Headers

Response

Errors