Labels
Labels are defined in your account and can be added to jobs, clients, suppliers, quotes, invoices, purchase orders and expenses to categorize them.
The endpoints on this page return the labels defined in your account. To add a label to an entity, use its id with the labels endpoints of the entity, for example Jobs - Labels, Clients - Labels, Suppliers - Labels, Quotes - Labels, Invoices - Labels or Purchase orders - Labels.
The label object
Properties
colorstring
The color of the label.
defaultForOutsourcingboolean
Only for the expense labels. True if the label is applied by default to the expenses created for an outsourced job.
idstring
The id of the label.
namestring
The name of the label.
label object
{
"id": "6654468b366ad245719322f4",
"name": "Urgent",
"color": "#991b1b"
}
List all job labels
This endpoint allows you to retrieve all the labels that can be used for jobs (the labels of jobs are also used for the groups).
Request
curl -G https://api.lsp.expert/v2/account/labels/jobs \
-u {key}:
Response
[
{
"id": "6654468b366ad245719322f4",
"name": "Urgent",
"color": "#991b1b"
},
{
"id": "6654469c366ad245719322f9",
"name": "Review needed",
"color": "#15803d"
}
// ...
]
List all client labels
This endpoint allows you to retrieve all the labels that can be used for clients.
Request
curl -G https://api.lsp.expert/v2/account/labels/clients \
-u {key}:
Response
[
{
"id": "66544708366ad24571932303",
"name": "VIP",
"color": "#075985"
},
{
"id": "6654471a366ad24571932308",
"name": "Agency",
"color": "#a16207"
}
// ...
]
List all supplier labels
This endpoint allows you to retrieve all the labels that can be used for suppliers.
Request
curl -G https://api.lsp.expert/v2/account/labels/suppliers \
-u {key}:
Response
[
{
"id": "66544735366ad2457193230d",
"name": "Preferred",
"color": "#15803d"
},
{
"id": "66544744366ad24571932312",
"name": "Freelancer",
"color": "#6b21a8"
}
// ...
]
List all quote labels
This endpoint allows you to retrieve all the labels that can be used for quotes.
Request
curl -G https://api.lsp.expert/v2/account/labels/quotes \
-u {key}:
Response
[
{
"id": "66544760366ad24571932317",
"name": "To follow up",
"color": "#c2410c"
},
{
"id": "6654476f366ad2457193231c",
"name": "Large account",
"color": "#075985"
}
// ...
]
List all invoice labels
This endpoint allows you to retrieve all the labels that can be used for invoices.
Request
curl -G https://api.lsp.expert/v2/account/labels/invoices \
-u {key}:
Response
[
{
"id": "66544783366ad24571932321",
"name": "Reminder sent",
"color": "#a16207"
},
{
"id": "66544792366ad24571932326",
"name": "Disputed",
"color": "#991b1b"
}
// ...
]
List all purchase order labels
This endpoint allows you to retrieve all the labels that can be used for purchase orders.
Request
curl -G https://api.lsp.expert/v2/account/labels/purchase-orders \
-u {key}:
Response
[
{
"id": "665447a4366ad2457193232b",
"name": "Approved",
"color": "#15803d"
},
{
"id": "665447b3366ad24571932330",
"name": "On hold",
"color": "#c2410c"
}
// ...
]
List all expense labels
This endpoint allows you to retrieve all the labels that can be used for expenses.
Request
curl -G https://api.lsp.expert/v2/account/labels/expenses \
-u {key}:
Response
[
{
"id": "665447c8366ad24571932335",
"name": "Software",
"color": "#075985",
"defaultForOutsourcing": false
},
{
"id": "665447d7366ad2457193233a",
"name": "Outsourcing",
"color": "#6b21a8",
"defaultForOutsourcing": true
}
// ...
]