Links
Link Retrieval
Get link destination by slug
GET
https://demo.getlynx.dev/api/link
Retrieves the destination of link by its slug (unauthed).
Query Parameters
Name | Type | Description |
---|---|---|
slug* | String | The slug of the link |
Get full link by slug
GET
https://demo.getlynx.dev/api/link
Retrieves the full link information by its slug.
Query Parameters
Name | Type | Description |
---|---|---|
id* | String | The slug of the link |
Headers
Name | Type | Description |
---|---|---|
Authorization | String | Your API key |
Cookies
Name | Type | Description |
---|---|---|
token | String | Your JWT Session |
Retrieve paginated links
GET
https://demo.getlynx.dev/api/link/list
Retrieve a list of paginated links that the user has permission to see. An admin can see all links but a standard user can only see their own.
Query Parameters
Name | Type | Description |
---|---|---|
pagesize* | String | Items to return in a page, up to 100. |
page* | String | The current page to return, 0-base indexed. |
sortType* | Intege | Order to sort by. -1 or 1. |
sortField* | String | Field to sort by. id, slug, destination, author, creationDate, modifiedDate or visits. |
search | String | Value to search slug and destination by. |
Headers
Name | Type | Description |
---|---|---|
Authorization | String | Your API key |
Cookies
Name | Type | Description |
---|---|---|
token | String | Your JWT Session |
Link Management
Create link
POST
https://demo.getlynx.dev/api/link
Creates a a link.
Headers
Name | Type | Description |
---|---|---|
Authorization | String | Your API key |
Cookies
Name | Type | Description |
---|---|---|
token | String | Your JWT Session |
Request Body
Name | Type | Description |
---|---|---|
slug* | string | The slug of the new link |
destination* | string | The destination of the new link |
Update link
PATCH
https://demo.getlynx.dev/api/link
Updates a a link.
Headers
Name | Type | Description |
---|---|---|
Authorization | String | Your API key |
Cookies
Name | Type | Description |
---|---|---|
token | String | Your JWT Session |
Request Body
Name | Type | Description |
---|---|---|
slug* | string | The slug of the link to set |
destination* | string | The destination of the link to set |
id* | String | The id of the link |
Delete link
DELETE
https://demo.getlynx.dev/api/link
Deletes a a link.
Headers
Name | Type | Description |
---|---|---|
Authorization | String | Your API key |
Cookies
Name | Type | Description |
---|---|---|
token | String | Your JWT Session |
Request Body
Name | Type | Description |
---|---|---|
ids* | Array | The id of links to remove |
Last updated