Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)
Request
query Parameters
created_after
string or null <date-time>
Default: null
Returns objects created after the entered date.
Example: created_after=2020-09-12T14:15:22Z
created_before
string or null <date-time>
Default: null
Returns objects created before the entered date.
Example: created_before=2020-12-13T16:17:28Z
id
integer or null
Default: null
Returns the object corresponding to the entered ID
name
string or null
Default: null
Filters the list by label name.
Example: name=SPAM
order
string or null
Default: null
Orders the list of results
Enum:null"asc""desc"
Example: order=desc
order_by
string or null
Default: null
criteria to order by
Example: order_by=name
page
integer or null >= 1
Default: 1
Defines the page number to be fetched.
Example: page=3
page_size
integer or null >= -1
Default: 20
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
Example: page_size=40
Responses
200
label search results
400
invalid search parameters
get/labels
Response samples
200
400
application/json
{
"edges": [
{
"cursor": 0,
"node": {
"created_by": 42,
"created_on": "2019-08-24T14:15:22Z",
"id": 0,
"info": {
"color": "#fe3423",
"description": "Flag resources as potentially harmfull"