Welcome to our new docs! Please keep in mind we are still working on making everything is as accurate as possible. Join us on discord and ask us questions if you are unsure.
DezerX Spartan Logo
Services

Get Services List

Retrieve a paginated list of services with optional filtering by search term and status

GET
/api/application/services
AuthorizationBearer <token>

Bearer token authentication

In: header

Query Parameters

per_page?integer

Number of services per page

Default15
Range1 <= value <= 100
search?string

Search term for service name, product name, or owner details

status?string

Filter by service status

Value in"active" | "suspended" | "terminated" | "pending"

Response Body

curl -X GET "https://api.example.com/api/application/services?per_page=15&search=string&status=active"
{
  "success": true,
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "service_name": "Web Hosting Premium",
        "product_id": 1,
        "category_id": 1,
        "owner_id": 1,
        "extra_owners": null,
        "price": "25.00",
        "original_price": null,
        "coupon_id": null,
        "billing_cycle": "yearly",
        "due_date": "2024-12-31T23:59:59.000000Z",
        "status": "active",
        "module": "HostingModule",
        "config": {
          "domain": "example.com",
          "created_at": "2024-01-01T00:00:00.000000Z",
          "license_id": 1,
          "license_key": "LIC-XXXXXXXX-XXXXXXXX-XXXXXXXX",
          "last_rotated": "2024-01-01T00:00:00.000000Z"
        },
        "created_at": "2024-01-01T00:00:00.000000Z",
        "updated_at": "2024-01-01T00:00:00.000000Z",
        "last_reminded": null,
        "owner": {
          "id": 1,
          "name": "user@example.com",
          "email": "user@example.com"
        },
        "product": {
          "id": 1,
          "name": "Premium Hosting"
        },
        "category": {
          "id": 1,
          "name": "Web Hosting"
        }
      }
    ],
    "first_page_url": "https://api.example.com/api/application/services?page=1",
    "from": 1,
    "last_page": 10,
    "last_page_url": "https://api.example.com/api/application/services?page=10",
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "next_page_url": "https://api.example.com/api/application/services?page=2",
    "path": "https://api.example.com/api/application/services",
    "per_page": 15,
    "prev_page_url": null,
    "to": 15,
    "total": 150
  }
}
{
  "success": false,
  "message": "Unauthorized"
}
{
  "success": false,
  "message": "Insufficient permissions"
}
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "price": [
      "The price field is required."
    ]
  }
}