List auditable entities

Read all auditable entities of your account.

Returns every auditable entity of the authenticated client. Use it to find the id to pass as audit_for when you calculate for one of your legal entities.

Request

GET /v2/audits/entities

The endpoint takes no parameters.

curl "https://api.sandbox.squake.earth/v2/audits/entities" \
  --header "Authorization: Bearer $SQUAKE_API_KEY"

Response

The body is a JSON array of entities:

200 OKapplication/json
[
  {
    "id": "d3427e0d-5a3c-40ce-842e-5552e77caa4f",
    "legal_name": "Example Company GmbH",
    "email": "accounting@example.com",
    "vat_id": "DE123456789",
    "external_id": "ENTITY-001",
    "address": {
      "line1": "Example Street 1",
      "line2": "Building A",
      "city": "Berlin",
      "postal_code": "10115",
      "state": "BE",
      "country_alpha2": "DE",
      "email": "accounting@example.com"
    }
  },
  {
    "id": "7b1f3e92-04c6-4d8a-b5e3-2a9c6f1d8e47",
    "legal_name": "Example Company Ltd",
    "email": "finance@example.co.uk",
    "vat_id": "GB123456789",
    "external_id": "ENTITY-002",
    "address": {
      "line1": "1 Example Road",
      "city": "London",
      "postal_code": "EC1A 1BB",
      "country_alpha2": "GB"
    }
  }
]
FieldTypeDescription
idstring (UUID)Identifier of the entity. Pass it as audit_for in calculation requests.
legal_namestringThe legal name of the entity.
emailstringThe email address associated with the entity.
vat_idstringThe entity's VAT identification number.
external_idstringYour own identifier for the entity.
addressobjectThe entity's address. See Address fields.

Errors

StatusMeaning
403Authentication or authorization failed. Check that audit logging is enabled for your account.

On this page

GET/v2/audits/entities

Run this request against the sandbox with your test key.

Open in API reference