Skip to main content
GET
/
deliver
/
businesses
Get all businesses
curl --request GET \
  --url https://api-sandbox.orum.io/deliver/businesses \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'
{
  "businesses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_reference_id": "<string>",
      "legal_name": "<string>",
      "business_name": "<string>",
      "entity_type": "<string>",
      "tax_id_type": "<string>",
      "account_holder_name": "<string>",
      "incorporation_date": "<string>",
      "status": "created",
      "addresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "home",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "US",
          "zip5": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "contacts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "email",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "closed_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Headers

Orum-Version
enum<string>
required
Available options:
v2022-09-21

Query Parameters

index
integer
default:0
Required range: x >= 0
size
integer
default:100
Required range: 0 <= x <= 500
customer_reference_id
string
Required string length: 1 - 255
status
enum<string>[]
start_time
string<date-time>
end_time
string<date-time>
Maximum length: 255
account_number
string
id
string<uuid>

Response

businesses
BusinessResponseBase · object[]
required