List Links
GET Returns a list of all your links.
Request
Query Parameters
Pagination
| Name | Type | Required | Notes |
|---|---|---|---|
| page | integer | false | The page number to request. Otherwise, the first page will be returned |
| per_page | integer | false | The number of items to return per page. Default: 15 Max: 30 |
Example
curl -L -X GET 'https://prettyurl.net/api/v1/links' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY>'Response
Schema
pagination
| Key | Type | Notes |
|---|---|---|
| current_page | integer | The current page |
| total_pages | integer | The total number of pages |
| total | integer | The total number of items across all pages |
| per_page | integer | The number of items per page |
links object
| Key | Type |
|---|---|
| id | string |
| title | string |
| domain | string |
| group | object |
| back_half | string |
| short_link | string |
| original_link | string |
| updated_at | datetime |
| created_at | datetime |
Example
{
"status": "success",
"message": "API request processed successfully.",
"data": {
"links": [
{
"id": string,
"title": string,
"domain": string,
"group": {
"id": string,
"name": string,
"created_at": datetime
},
"back_half": string,
"short_link": string,
"original_link": string,
"updated_at": datetime,
"created_at": datetime
}
],
"pagination": {
"current_page": number,
"total_pages": number,
"total": number,
"per_page": number
}
}
}