Labels
Use the following parameters to search labels.
Authorizations
Query parameters
created_afterstring · date-time | nullableOptionalDefault:
Returns objects created after the entered date.
null
Example: 2020-09-12T14:15:22Z
created_beforestring · date-time | nullableOptionalDefault:
Returns objects created before the entered date.
null
Example: 2020-12-13T16:17:28Z
idinteger | nullableOptionalDefault:
Returns the object corresponding to the entered ID
null
namestring | nullableOptionalDefault:
Filters the list by label name.
null
Example: SPAM
orderstring · enum | nullableOptionalDefault:
Orders the list of results
null
Example: desc
Possible values: order_bystring | nullableOptionalDefault:
criteria to order by
null
Example: name
pageinteger | nullableOptionalDefault:
Defines the page number to be fetched.
1
Example: 3
page_sizeinteger | nullableOptionalDefault:
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
20
Example: 40
Responses
200
label search results
application/json
400
invalid search parameters
application/json
get
GET /labels HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
"edges": [
{
"cursor": 0,
"node": {
"created_by": 42,
"created_on": "2025-06-22T14:22:25.137Z",
"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"
}
}
],
"page_info": {
"count": 1,
"has_next_page": false
}
}
Create a label than can be attached to Account or Transaction
Authorizations
Body
namestringRequiredExample:
label's name
SPAM
Responses
200
The new label
application/json
400
Invalid label attributes
application/json
post
POST /labels HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"info": {
"color": "#fe3423",
"description": "Flag resources as potentially harmfull"
},
"name": "SPAM"
}
{
"created_by": 42,
"created_on": "2025-06-22T14:22:25.137Z",
"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"
}
This method returns the label that matches the entered ID.
Authorizations
Path parameters
label_idintegerRequired
The label's ID
Responses
200
label object
application/json
404
label not found
application/json
get
GET /labels/{label_id} HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
"created_by": 42,
"created_on": "2025-06-22T14:22:25.137Z",
"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"
}
Set the new properties to the label matching the given ID
Authorizations
Path parameters
label_idintegerRequired
Body
namestringRequiredExample:
label's name
SPAM
Responses
200
The new version of the label
application/json
400
Invalid data
application/json
404
The label does not exist
application/json
put
PUT /labels/{label_id} HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"info": {
"color": "#fe3423",
"description": "Flag resources as potentially harmfull"
},
"name": "SPAM"
}
{
"created_by": 42,
"created_on": "2025-06-22T14:22:25.137Z",
"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"
}
Delete a label
Authorizations
Path parameters
label_idintegerRequired
Responses
200
Whether or not the Label has been successfully deleted
application/json
404
The label does not exist
application/json
delete
DELETE /labels/{label_id} HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
"success": true
}