Legal Entities

Lists all legal entities

get

Authorizations

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/core/legal-entities HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "crn": "text",
        "vatNumber": "text",
        "businessName": "text",
        "businessCategory": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text"
      }
    ],
    "next": "text"
  }
}

Returns a specific legal entity

get

Authorizations

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/core/legal-entities/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "crn": "text",
      "vatNumber": "text",
      "businessName": "text",
      "businessCategory": "text",
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text"
    }
  }
}

Exports all legal entities with support for incremental fetching.

get

Authorizations

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/core/legal-entities/export HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "crn": "text",
        "vatNumber": "text",
        "businessName": "text",
        "businessCategory": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text"
      }
    ],
    "next": "text"
  }
}