List all Inquiries

GET

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

GET

/api/v1/inquiries

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

Try it

200Retrieved

1 {
2   "data": [
3     {
4       "type": "inquiry",
5       "id": "inq_zEx4jL84ShbUyuwX6AzPSqt6",
6       "attributes": {
7         "status": "completed",
8         "subject": {},
9         "reference-id": {},
10         "created-at": "2019-11-15T05:27:24.000Z",
11         "completed-at": "2019-11-15T05:28:02.000Z",
12         "expired-at": {}
13       },
14       "relationships": {
15         "account": {
16           "data": {
17             "type": "account",
18             "id": "act_n2uq9eKMboaCQzu9ALWYcVdN"
19           }
20         },
21         "template": {
22           "data": {
23             "type": "template",
24             "id": "tmpl_DyLDeD3ftjxuMstYTvgwPX5f"
25           }
26         },
27         "reports": {
28           "data": []
29         },
30         "verifications": {
31           "data": [
32             {
33               "type": "verification/database",
34               "id": "ver_uHDiwtcx3htjajvEaeMjPQcE"
35             }
36           ]
37         },
38         "sessions": {
39           "data": [
40             {
41               "type": "session",
42               "id": "iqse_ov4ftVuCYm8U7rNkZADFpiBg"
43             }
44           ]
45         }
46       }
47     }
48   ],
49   "links": {
50     "prev": {},
51     "next": "/api/v1/inquiries?page%5Bafter%5D=inq_ByBdXDqUrguLAHjGZMuDZLCx"
52   }
53 }

Returns a list of your organization’s inquiries.

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

Query parameters

page[after]stringOptional

Inquiry ID for pagination cursor

page[before]stringOptional

Inquiry ID for pagination cursor

page[size]stringOptional

Limit on the number of inquiries returned

filter[account-id]stringOptional

Filter inquiries by account ID

filter[reference-id]stringOptional

Filter inquiries by reference ID

Response

200

datalist of objects or null

linksobject or null

Headers

Query parameters

Response