Entities

Search Entity

get

Use the following parameters to search entities.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Query parameters

accountinteger[] | nullableOptional

Filters by account tied to this entity

Default: null

created_afterstring · date-time | nullableOptional

Returns objects created after the entered date.

Default: nullExample: 2020-09-12T14:15:22Z

created_beforestring · date-time | nullableOptional

Returns objects created before the entered date.

Default: nullExample: 2020-12-13T16:17:28Z

idinteger | nullableOptional

Returns the object corresponding to the entered ID

Default: null

namestring | nullableOptional

Filters the list by entity name.

Default: nullExample: trading_entity_1

orderstring · enum | nullableOptional

Orders the list of results

Default: nullExample: descPossible values:

order_bystring | nullableOptional

criteria to order by

Default: nullExample: name

pageinteger | nullableOptional

Defines the page number to be fetched.

Default: 1Example: 3

page_sizeinteger | nullableOptional

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate

Default: 20Example: 40

Responses

200

entity search results

application/json

400

invalid search parameters

application/json

get

HTTPcURLJavaScriptPython

GET /entities HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "edges": [
    {
      "cursor": 0,
      "node": {
        "accounts": [
          1
        ],
        "created_by": 5,
        "created_on": "2025-05-30T17:04:36.613Z",
        "id": 1,
        "last_request": 3,
        "name": "text",
        "status": "text"
      }
    }
  ],
  "page_info": {
    "count": 1,
    "has_next_page": false
  }
}

Get an entity by ID

get

This method returns the entity that matches the entered ID.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Path parameters

entity_idintegerRequired

The entity's ID

Responses

200

entity object

application/json

404

entity not found

application/json

get

HTTPcURLJavaScriptPython

GET /entities/{entity_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "accounts": [
    1
  ],
  "created_by": 5,
  "created_on": "2025-05-30T17:04:36.613Z",
  "id": 1,
  "last_request": 3,
  "name": "text",
  "status": "text"
}