List businesses

GET

https://api.middesk.com/v1/businesses

GET

/v1/businesses

$ curl https://api.middesk.com/v1/businesses \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "object": "list",
3   "has_more": true,
4   "data": [
5     {
6       "object": "business",
7       "id": "id",
8       "name": "name",
9       "status": "open",
10       "created_at": "2024-01-15T09:30:00Z",
11       "updated_at": "2024-01-15T09:30:00Z",
12       "external_id": "external_id",
13       "unique_external_id": "unique_external_id",
14       "tags": [
15         "tags"
16       ],
17       "review": {
18         "object": "review",
19         "id": "id",
20         "created_at": "2024-01-15T09:30:00Z",
21         "updated_at": "2024-01-15T09:30:00Z",
22         "tasks": [
23           {
24             "category": "bankruptcies",
25             "key": "location_frequency",
26             "label": "Politically Exposed Persons",
27             "message": "message",
28             "name": "name",
29             "status": "success",
30             "sub_label": "sub_label",
31             "sources": [
32               {
33                 "id": "id",
34                 "type": "type",
35                 "metadata": {
36                   "key": "value"
37                 }
38               }
39             ]
40           }
41         ],
42         "assignee": {
43           "object": "user",
44           "id": "id",
45           "name": "name",
46           "email": "email",
47           "roles": [
48             "roles"
49           ],
50           "created_at": "2024-01-15T09:30:00Z"
51         }
52       },
53       "assignee": {
54         "object": "user",
55         "id": "id",
56         "name": "name",
57         "email": "email",
58         "roles": [
59           "roles"
60         ],
61         "created_at": "2024-01-15T09:30:00Z"
62       },
63       "website": {
64         "object": "website"
65       },
66       "orders": [
67         {
68           "object": "order",
69           "id": "id",
70           "status": "created",
71           "business_id": "business_id",
72           "product": "identity",
73           "created_at": "2024-01-15T09:30:00Z",
74           "updated_at": "2024-01-15T09:30:00Z"
75         }
76       ]
77     }
78   ],
79   "total_count": 1
80 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

businesses list

objectstring

has_moreboolean

datalist of objectsOptional

total_countintegerOptional