API Reference
Links
Create, list, get, update, and delete deep links.
Create a Link
POST/links
Create a link
Request Body
| Field | Type | Description |
|---|
destination_url* | string | |
slug | string | Custom slug. Auto-generated if omitted. |
ios_url | string | |
ios_fallback_url | string | |
android_url | string | |
android_fallback_url | string | |
og_title | string | |
og_description | string | |
og_image_url | string | |
tags | string[] | |
expires_at | string | Must be in the future. |
password | string | |
app_id | string | |
Responses
201Link created
| Field | Type | Description |
|---|
id | string | |
short_url | string | e.g. https://aplnk.to/abc123 |
slug | string | e.g. abc123 |
domain | string | e.g. aplnk.to |
destination_url | string | |
ios_url | string | null | |
ios_fallback_url | string | null | |
android_url | string | null | |
android_fallback_url | string | null | |
og_title | string | null | |
og_description | string | null | |
og_image_url | string | null | |
app_id | string | null | |
expires_at | string | null | |
is_active | boolean | |
tags | string[] | |
created_at | string | |
updated_at | string | |
400Validation error
| Field | Type | Description |
|---|
error* | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
409Slug already taken
| Field | Type | Description |
|---|
error* | object | |
429Rate limit exceeded
| Field | Type | Description |
|---|
error* | object | |
List Links
GET/links
List links
Parameters
| Name | Type | In | Description |
|---|
limit | integer | query | |
offset | integer | query | |
tag | string | query | |
is_active | "true" | "false" | query | |
search | string | query | |
Responses
200List of links
| Field | Type | Description |
|---|
data | object[] | |
pagination | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
Get a Link
GET/links/{id}
Get a link
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200Link details
| Field | Type | Description |
|---|
id | string | |
short_url | string | e.g. https://aplnk.to/abc123 |
slug | string | e.g. abc123 |
domain | string | e.g. aplnk.to |
destination_url | string | |
ios_url | string | null | |
ios_fallback_url | string | null | |
android_url | string | null | |
android_fallback_url | string | null | |
og_title | string | null | |
og_description | string | null | |
og_image_url | string | null | |
app_id | string | null | |
expires_at | string | null | |
is_active | boolean | |
tags | string[] | |
created_at | string | |
updated_at | string | |
404Not found
| Field | Type | Description |
|---|
error* | object | |
Update a Link
PATCH/links/{id}
Update a link
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Request Body
| Field | Type | Description |
|---|
destination_url | string | |
ios_url | string | null | |
ios_fallback_url | string | null | |
android_url | string | null | |
android_fallback_url | string | null | |
og_title | string | null | |
og_description | string | null | |
og_image_url | string | null | |
tags | array | null | |
expires_at | string | null | |
password | string | null | |
app_id | string | null | |
Responses
200Updated link
| Field | Type | Description |
|---|
id | string | |
short_url | string | e.g. https://aplnk.to/abc123 |
slug | string | e.g. abc123 |
domain | string | e.g. aplnk.to |
destination_url | string | |
ios_url | string | null | |
ios_fallback_url | string | null | |
android_url | string | null | |
android_fallback_url | string | null | |
og_title | string | null | |
og_description | string | null | |
og_image_url | string | null | |
app_id | string | null | |
expires_at | string | null | |
is_active | boolean | |
tags | string[] | |
created_at | string | |
updated_at | string | |
400Validation error
| Field | Type | Description |
|---|
error* | object | |
404Not found
| Field | Type | Description |
|---|
error* | object | |
Delete a Link
DELETE/links/{id}
Delete a link
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200Deleted link
| Field | Type | Description |
|---|
id | string | |
short_url | string | e.g. https://aplnk.to/abc123 |
slug | string | e.g. abc123 |
domain | string | e.g. aplnk.to |
destination_url | string | |
ios_url | string | null | |
ios_fallback_url | string | null | |
android_url | string | null | |
android_fallback_url | string | null | |
og_title | string | null | |
og_description | string | null | |
og_image_url | string | null | |
app_id | string | null | |
expires_at | string | null | |
is_active | boolean | |
tags | string[] | |
created_at | string | |
updated_at | string | |
404Not found
| Field | Type | Description |
|---|
error* | object | |