List legal entities

GEThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/legal_entities

Language

Credentials

Secret key

Instance keyRemember on this device

Kept in this browser tab unless you tick Remember; don't on a shared computer. Use keys from a sandbox account to test without moving money.

Parameters

Query

criteriaorderexpandlimitoffset

cURL request

curl --request GET \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entities \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entities';
const options = {method: 'GET', headers: {Authorization: 'Basic <base64 of SECRET_KEY:>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entities"

headers = {"Authorization": "Basic <base64 of SECRET_KEY:>"}

response = requests.get(url, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entities', [
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entities"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Basic <base64 of SECRET_KEY:>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://app.shuttleglobal.com/c/api/legal_entities';
const options = {method: 'GET', headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.shuttleglobal.com/c/api/legal_entities', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/legal_entities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/legal_entities"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response

List of legal entities

{
  "legal_entities": [
    {
      "id": "string",
      "name": "string",
      "code": "string",
      "division": "string",
      "country": "string",
      "company_type": "string",
      "company_type_name": "string",
      "company_number": "string",
      "charity_number": "string",
      "vat_number": "string",
      "address": {},
      "phone": "string",
      "email": "string",
      "website": "string",
      "support_url": "string",
      "privacy_policy": "string",
      "tcs": "string",
      "metadata": {},
      "tags": "string",
      "status": "LINKED",
      "created": "2026-01-01T12:00:00Z",
      "created_session": "string",
      "updated": "2026-01-01T12:00:00Z",
      "updated_session": "string",
      "v": 0
    }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}

GET

/legal_entities

Search and list legal entity objects with pagination support.

Authorizations

basicAuth
bearerAuth

Parameters

Query Parameters

criteria

string

Search criteria for filtering legal entities. Available fields: id, code, company_type, created, division, name, status, tags, updated

Examples:

status=ACTIVE
company_type=GB_LIMITED_COMPANY
code=ORG

order

string

Sort order for results. Supports any field that criteria supports. Defaults to created:desc if not specified. Append :desc for descending order.

expand

string

Fields to expand into full objects. Separate multiple fields with commas.

Available fields:

created_session (session object)
updated_session (session object)

limit

integer

Number of records to return: 20 if not set, at most 1000.

offset

integer

Number of records to skip before the first one returned. offset + limit can’t exceed 5000; to read further, page by a field such as created instead. See Paging through results.

Responses

200

List of legal entities

application/json

object

legal_entities

Array<object>

A legal entity representing a business or organisation that receives payments

object

string

Unique identifier for the legal entity

Pattern /^le_[0-9]+_[0-9]+$/

name

string

Name of the legal entity

code

string

Your identifier for the legal entity (displayed on merchant portal)

division

string

Division ID

country

string

Country code

company_type

string

Type of company (e.g., GB_LIMITED_COMPANY)

company_type_name

string

Human-readable company type name

company_number

string

Company registration number

charity_number

string

Charity registration number

vat_number

string

VAT registration number

address

object

Registered address

object

country

string

line1

string

line2

string

line3

string

line4

string

line5

string

line6

string

phone

string

Contact phone number

email

string

Contact email address

website

string

Website URL

support_url

string

Support page URL

privacy_policy

string

tcs

string

Terms and conditions URL

metadata

object

Custom key-value pairs

object

key

additional properties

any

tags

string

CSV of tags/references

status

string · enum

Status of the legal entity:

LINKED - active but not yet had any payments taken
ACTIVE - active and in use
ARCHIVE - disconnected and archived
SETUP, CREATED, INACTIVE, RUNDOWN - enterprise statuses

Allowed values: LINKED ACTIVE ARCHIVE SETUP CREATED INACTIVE RUNDOWN

created

string · date-time

When the legal entity was created

created_session

string

Session that created this legal entity

updated

string · date-time

When the legal entity was last updated

updated_session

string

Session that last updated this legal entity

integer

Version of the record

meta

object

limit

integer

offset

integer

total

integer

400

Bad request

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

401

Unauthorised: the API key is missing or not valid

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

Example

{
  "code": "UNAUTHORIZED",
  "message": "Unauthorised"
}

Was this page helpful?