Label List
Retrieve shipping labels for your company.
GET
/api/v1/shipping/labels?page=1Description
Returns paginated shipping labels with tracking numbers and recipient details.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | No | Page number (1-based). Default is 1. |
| limit | number | No | Records per page. Default is 10. Max 100 on tickets, wallet, and shipping labels. |
| country | string | No | Filter by country code. |
| start_date | string | No | On or after this date (YYYY-MM-DD; shipping labels also accept MM/DD/YYYY). |
| end_date | string | No | On or before this date (YYYY-MM-DD; shipping labels also accept MM/DD/YYYY). |
Response
| Field | Type | Description |
|---|---|---|
| labels | array | Shipping label records. |
| labels[].id | string | Label pass the full value from the api response in path parameters. |
| labels[].creator_firstname | string | Creator (Unduit user) first name. |
| labels[].creator_lastname | string | Creator (Unduit user) last name. |
| labels[].ship_from_first_name | string | Ship-from contact first name on the label. |
| labels[].ship_from_last_name | string | Ship-from contact last name on the label. |
| labels[].address_line_1 | string | Ship-from address line 1. |
| labels[].address_line_2 | string | Ship-from address line 2. |
| labels[].address_1 | string | Alias of address_line_1. |
| labels[].address_2 | string | Alias of address_line_2. |
| labels[].city | string | Ship-from city. |
| labels[].state | string | Ship-from state. |
| labels[].zip | string | Ship-from postal code. |
| labels[].country | string | Ship-from country code. |
| labels[].lbs | string | Package weight (pounds). |
| labels[].oz | string | Package weight (ounces). |
| labels[].length | string | Package length (inches). |
| labels[].width | string | Package width (inches). |
| labels[].height | string | Package height (inches). |
| labels[].label_count | number | Number of labels in the shipment. |
| labels[].label_to_contacts | number | 1 when label was emailed to contacts. |
| labels[].label_to_me | number | 1 when label was emailed to the creator. |
| labels[].recipient_name | string | Recipient name. |
| labels[].recipient_company | string | Recipient company. |
| labels[].label_url | string | URL to download the merged label PDF. |
| labels[].created_at | string | Label creation timestamp. |
| labels[].updated_at | string | Label last update timestamp. |
| labels[].tracking_numbers | array | Tracking rows for this label. |
| labels[].tracking_numbers[].track_number | string | Carrier tracking number. |
| labels[].tracking_numbers[].price | number | Label price. |
| labels[].tracking_numbers[].label_service | number | Label service type ID. |
| labels[].tracking_numbers[].carrier | string | Carrier ID (e.g. 2 = UPS). |
| labels[].tracking_numbers[].tracking_link | string | Carrier tracking URL. |
| labels[].users | array | Contact recipients when label_to_contacts is set. |
| labels[].users[].contact_name | string | Recipient contact name. |
| labels[].users[].contact_email | string | Recipient contact email. |
| current_page | number | Current page number. |
| total_pages | number | Total pages. |
| total | number | Total matching labels. |
| per_page | number | Page size. |
| from | number | First item index on this page. |
| to | number | Last item index on this page. |
Notes
- creator_firstname and creator_lastname are the Unduit user who created the label.
- ship_from_first_name and ship_from_last_name are the ship-from contact on the label; they may differ from the creator.
- address_1 and address_2 are legacy aliases of address_line_1 and address_line_2 (same values). Both sets are returned for Clover API compatibility.
- users lists recipients when label_to_contacts is set; each entry has contact_name and contact_email.
Related Endpoints
Did this page help you?
Request
curl -X GET https://uat.unduit.com/api-exposed/api/v1/shipping/labels?page=1 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response
{
"labels": [
{
"id": "3659204-9876",
"creator_firstname": "Robert",
"creator_lastname": "Admin",
"ship_from_first_name": "Jane",
"ship_from_last_name": "Smith",
"address_line_1": "100 Main St",
"address_line_2": "",
"address_1": "100 Main St",
"address_2": "",
"city": "Austin",
"state": "TX",
"zip": "78701",
"country": "US",
"lbs": "2",
"oz": "0",
"length": "12",
"width": "10",
"height": "4",
"label_count": 1,
"label_to_contacts": 0,
"label_to_me": 0,
"recipient_name": "Unduit Warehouse",
"recipient_company": "Unduit Logistics",
"label_url": "https://uat.unduit.com/api-exposed/show-my-file?path=assets/uploads/shipstationlabels/merge/&filename=label_9876.pdf&is_encrypted=1",
"created_at": "2026-06-02 15:00:00",
"updated_at": "2026-06-02 15:00:00",
"tracking_numbers": [
{
"track_number": "1Z999AA10123456784",
"price": 12.5,
"label_service": 0,
"carrier": "2",
"tracking_link": "https://wwwapps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&loc=en_US&tracknum=1Z999AA10123456784"
}
],
"users": []
}
],
"current_page": 1,
"total_pages": 1,
"total": 1,
"per_page": 10,
"from": 1,
"to": 1
}