Transaction Labels

Get a transaction's labels

get

This method returns the transaction's labels.

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

transaction_idintegerRequired

The transaction's ID

Responses

200

Transaction object

application/json

created_byintegerRequired

id of the creator

Example: 42

created_onstring · date-timeRequired

idintegerRequired

namestringRequired

name of the tag

Example: SPAM

updated_byintegerRequired

id of the last updater

Example: 42

updated_onstring · date-timeRequired

date on which the tag has been last updated

Example: 2023-02-06T02:48:59+00:00

404

Transaction not found

application/json

get

/transactions/{transaction_id}/labels

HTTPcURLJavaScriptPython

GET /transactions/{transaction_id}/labels HTTP/1.1
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

[
  {
    "created_by": 42,
    "created_on": "2026-03-15T11:10:45.279Z",
    "id": 1,
    "info": {
      "color": "#fe3423",
      "description": "Flag resources as potentially harmfull"
    },
    "name": "SPAM",
    "updated_by": 42,
    "updated_on": "2023-02-06T02:48:59+00:00"
  }
]

Add a Label to the Transaction matching the ID

post

This post endpoint set the Label matching the ID passed in the payload to the Transaction matching the ID passed in the url

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

transaction_idintegerRequired

The transaction's ID

Body

application/json

label_idintegerRequired

ID of the label to add to the resource

Example: 42

Responses

200

Whether or not the Label has been successfully attached

application/json

successbooleanRequiredExample: true

404

Transaction or Label does not exist

application/json

post

/transactions/{transaction_id}/labels

HTTPcURLJavaScriptPython

POST /transactions/{transaction_id}/labels HTTP/1.1
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "label_id": 42
}

{
  "success": true
}

Remove a Label to the Transaction matching the ID

delete

This post endpoint remove the Label from the transaction matching the IDs passed in url

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

label_idintegerRequired

The label's ID

transaction_idintegerRequired

The transaction's ID

Responses

200

Whether or not the Label has been successfully removed

application/json

successbooleanRequiredExample: true

404

Transaction or Label does not exist

application/json

delete

/transactions/{transaction_id}/labels/{label_id}

HTTPcURLJavaScriptPython

DELETE /transactions/{transaction_id}/labels/{label_id} HTTP/1.1
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "success": true
}