.png)
Mon-Fri 10am - 6pm
List URL Links
Base URL for your account: https://cpaas.studio
GET
/api/v1/urlinks
Retrieves a paginated list of short links belonging to your account.
Parameters
| Param | Type | Required | Notes |
|---|---|---|---|
search |
string | no | Search term to filter by name, slug, or redirect URL. |
status |
string | no | Filter by status: pending, approved, rejected, or disabled. |
auto_renew |
boolean | no | Filter by auto-renew toggle state. |
page |
integer | no | Page number for pagination. Default: 1. |
per_page |
integer, max 100 | no | Items per page. Default: 15. |
Request example
curl -X GET "https://cpaas.studio/api/v1/urlinks?status=approved&per_page=15" \
-H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"<?php
$ch = curl_init('https://cpaas.studio/api/v1/urlinks?status=approved&per_page=15');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);Success response (data)
{
"data": [
{
"id": 15,
"name": "Summer Promo Landing Page",
"slug": "summer-promo",
"redirect_url": "https://example.com/promotions/summer-2026",
"status": "approved",
"auto_renew": true,
"clicks_count": 42,
"expires_at": "2027-09-16T17:46:25+00:00",
"created_at": "2026-09-16T17:46:25+00:00"
}
],
"meta": {
"page": 1,
"per_page": 15,
"total": 1,
"total_pages": 1
}
}Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.