API Documentation
Explore how to integrate with our API.
Our API is designed with stability in mind. We do not implement versioning as we are committed to maintaining backward compatibility. Any future enhancements will be made in a non-breaking manner to ensure your integrations continue to work seamlessly.
Categories
GET
/api/categories
- Retrieve all categories with their associated carriers.
Response Format:
{
"data": [
{
"id": 1,
"name": "Category Name",
"carriers": [
{
"id": 1,
"name": "Carrier Name"
}
]
}
]
}
GET
/api/categories/:name
- Search for a specific category by name (supports partial matches).
Parameters:
name - Category name to search for
Response Format:
{
"data": {
"id": 1,
"name": "Category Name",
"carriers": [
{
"id": 1,
"name": "Carrier Name"
}
]
}
}
Carriers
GET
/api/carriers
- Retrieve all carriers with their associated email.
Response Format:
{
"data": [
{
"id": 1,
"name": "Carrier Name",
"emails": [
{
"id": 1,
"email": "[email protected]"
}
]
}
]
}
GET
/api/carriers/:id
- Retrieve a specific carrier by ID with its email.
Parameters:
id - Carrier ID
Response Format:
{
"data": {
"id": 1,
"name": "Carrier Name",
"emails": [
{
"id": 1,
"email": "[email protected]"
}
]
}
}
Emails
GET
/api/emails
- Retrieve all carrier email.
Response Format:
{
"data": [
{
"id": 1,
"email": "[email protected]"
}
]
}