Skip to main content
Version: v2alpha1

View accounts using the API

Before you start​

Steps​

1. List accounts​

List the accounts by calling GET /accounts using any filter needed. Check the pagination to understand how list of resources work.

Response​

200 OK
{
  "cursor": "Q3VyaW9zaXR5IEtpbGxlZCB0aGUgQ2F0Cg==",
  "data": [
    {
      "id": "acc_4ehg1mkv3mvt3256vcn8dspb4h",
      "version": "20240229153000000",
      "business_profile": {
        "type": "company",
        "legal_name": "Wildcat Pumps Org",
        "registration_number": "DE123456789",
      },
      "country": "DE",
      "intraorganizational": true,
      "capabilities": {
        "receive_invoices": {
          "enabled": true,
          "status": "active",
          "from": "2024-09-03T16:19:53.4298639Z",
          "settings": {
            [...]
          }
        },
        [...]
      }
    },
    {
      "id": "acc_4ve0983428h1a56b52sm9v98df",
      "version": "20240229153000000",
      "business_profile": {
        "type": "company",
        "legal_name": "Acme Inc.",
        "registration_number": "DE987654321",
      },
      "country": "DE",
      "intraorganizational": false,
      "capabilities": {
        [...]
      },
      [...]
    },
    [...]
  ]
}

2. Get account details​

From the previous response, you can get the internal account id and get more details about that specific account by calling GET /accounts/{account_id}.

Response​

200 OK
{
  "id": "acc_4ehg1mkv3mvt3256vcn8dspb4h",
  "version": "20240229153000000",
  "business_profile": {
    "type": "company",
    "legal_name": "Wildcat Pumps Org",
    "registration_number": "DE123456789",
  },
  "country": "DE",
  "intraorganizational": true,
  "capabilities": {
    "receive_invoices": {
      "enabled": true,
      "status": "active",
      "from": "2024-09-03T16:19:53.4298639Z",
      "settings": {
        "notifications": [
          {
            "type": "email",
            "to": ["invoices@example.com"],
            "cc": ["cc@example.com"],
            "bcc": ["bcc@example.com"]
          }
        ]
      }
    },
    [...]
  }
}