List businesses

GET

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

GET

/v1/businesses

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

200Retrieved

{
  "data": [
    {
      "object": "business",
      "id": "id",
      "name": "name",
      "status": "open",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "external_id": "external_id",
      "unique_external_id": "unique_external_id",
      "tags": [
        "tags"
      ],
      "review": {
        "object": "review",
        "id": "id",
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z",
        "tasks": [
          {
            "category": "bankruptcies",
            "key": "location_frequency",
            "label": "Politically Exposed Persons",
            "message": "message",
            "name": "name",
            "status": "success",
            "sub_label": "sub_label",
            "sources": [
              {
                "id": "id",
                "type": "type",
                "metadata": {
                  "key": "value"
                }
              }
            ]
          }
        ],
        "assignee": {
          "object": "user",
          "id": "id",
          "name": "name",
          "email": "email",
          "roles": [
            "roles"
          ],
          "created_at": "2024-01-15T09:30:00Z"
        }
      },
      "assignee": {
        "object": "user",
        "id": "id",
        "name": "name",
        "email": "email",
        "roles": [
          "roles"
        ],
        "created_at": "2024-01-15T09:30:00Z"
      },
      "website": {
        "object": "website"
      },
      "orders": [
        {
          "object": "order",
          "id": "id",
          "status": "created",
          "business_id": "business_id",
          "product": "identity",
          "created_at": "2024-01-15T09:30:00Z",
          "updated_at": "2024-01-15T09:30:00Z"
        }
      ]
    }
  ],
  "object": "list",
  "has_more": true,
  "total_count": 1
}

Authentication

AuthorizationBearer

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

Response

businesses list

datalist of objects

objectstring

has_moreboolean

total_countintegerOptional