FluentCRM Developers

Appearance

View as Markdown

GET List Smart Links​

GET
/smart-links

Retrieve a paginated list of smart links. Smart links are trackable URLs that can automatically apply actions (add/remove tags, add/remove lists) when a contact clicks them. Supports search and sorting. Requires FluentCampaign Pro.

Required capability: fcrm_manage_settings

Enforced by SmartLinksPolicy::verifyRequest(), the policy default for this route group.

Requires: FluentCampaign Pro. Without it the route does not exist.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

search

Search smart links by title, target URL, or notes.

Type
string
orderBy

Column to sort by.

Type
string
Default
"id"
order

Sort direction. Accepts ascending or descending (also asc/desc).

Type
string
Valid values
"ascending""descending""asc""desc"
Default
"desc"
per_page

Number of smart links per page.

Type
integer
Default
15
page

Page number for pagination.

Type
integer
Default
1

Responses​

Paginated list of smart links, or disabled status if the module is not activated.

application/json
JSON
{
"action_links": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"next_page_url": "string",
"prev_page_url": "string",
"from": 0,
"to": 0,
"data": [
{
"id": 0,
"title": "string",
"short": "string",
"target_url": "string",
"actions": {
"tags": [
0
],
"lists": [
0
],
"remove_tags": [
0
],
"remove_lists": [
0
],
"auto_login": "string"
},
"notes": "string",
"created_by": 0,
"created_at": "string",
"updated_at": "string",
"short_url": "string",
"detach_actions": {
"tags": [
0
],
"lists": [
0
]
},
"auto_login": "string"
}
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI