Get child entities

It is possible to get a list of all existing entities linked to a parent. Calling the GET endpoint will return a list of entities and their associated items.

GET//api/v1/entities

Authorization

api_key

Query parameters

Header parameters

Response

200401403404422500504

Ok

Body

application/json

entityId*string

The ID of the entity, found on the Company Dashboard

Example: "9906361a-7114-4756-9e7c-0752fd8378e8"

name*string

The name of the entity using Loop

Example: "My Company"

contractVersion*number (double)

Temporary field indicating the version of the contract the entity is using

Example: 1

parentId*nullable string

The optional ID of the parent entity if a child entity

Example: "9906361a-7114-4756-9e7c-0752fd8378e8"

delegatedSigning*boolean

A flag to indicate if the entity is using delegated signing

Example: true

inboundTreasuriesobject

The addresses of the wallets receiving transfers per network

replyTonullable string

The email address to set as the reply-to address for emails

Example: "[e-mail]"

websiteUrlnullable string

URL link to the entity's website

Example: "https://www.loopcrypto.xyz"

signupRedirectUrlnullable string

URL to redirect on signup for entity

Example: "https://www.loopcrypto.xyz/success"

logoUrlnullable string

URL link to the entity's logo

Example: "https://www.loopcrypto.xyz/logo.svg"

secretnullable string

The webhook secret to be used for signing and verifying webhooks

Example: "secret"

webhooksnullable array of WebhookDetails (object)

A list of configured webhooks

paymentPlatformProvider*nullable string

The name of the payment platform provider if configured. Possible values include "stripe", "chargebee"

externalSite*nullable string

Site details For entities with third party integration

Example: "loopcrypto-test"

cancellationDaysThreshold*number (double)

The number of days a payment is retried before an agreement is cancelled

Example: 7

Request

JavaScriptCurlPython

const response = await fetch('//api/v1/entities', {
    method: 'GET',
    headers: {
      "entity-id": "text"
    },
});
const data = await response.json();

Response

200401403404422500504

[
  {
    "entityId": "9906361a-7114-4756-9e7c-0752fd8378e8",
    "name": "My Company",
    "contractVersion": 1,
    "parentId": "9906361a-7114-4756-9e7c-0752fd8378e8",
    "delegatedSigning": true,
    "inboundTreasuries": {},
    "replyTo": "[e-mail]",
    "websiteUrl": "https://www.loopcrypto.xyz",
    "signupRedirectUrl": "https://www.loopcrypto.xyz/success",
    "logoUrl": "https://www.loopcrypto.xyz/logo.svg",
    "secret": "secret",
    "webhooks": [
      {
        "endpoint": "https://www.loopcrypto.xyz/webhook",
        "networkId": 137,
        "webhookEvent": "TransferProcessed",
        "contractAddress": "0x07865c6E87B9F70255377e024ace6630C1Eaa37F"
      }
    ],
    "paymentPlatformProvider": "text",
    "externalSite": "loopcrypto-test",
    "cancellationDaysThreshold": 7
  }
]