API Reference

List legal entities

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

Search and list legal entity objects with pagination support.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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
string

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

string

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

Available fields:

  • created_session (session object)
  • updated_session (session object)
integer

Maximum records to return

integer

Offset from first record

Responses

400

Bad request

Updated about 2 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago