API endpoint:
https://yesfree.us/api/v1/links
Request example:
curl --location --request GET 'https://yesfree.us/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
search
search_by
title
for Title, alias
for Alias, url
for URL. Defaults to: title
.status
0
for All, 1
for Active, 2
for Expired, 3
for Disabled. Defaults to: 0
.space_id
domain_id
pixel_id
sort_by
id
for Date created, clicks
for Clicks, title
for Title, alias
for Alias, url
for URL. Defaults to: id
.sort
desc
for Descending, asc
for Ascending. Defaults to: desc
.per_page
10
, 25
, 50
, 100
. Defaults to: 10
.API endpoint:
https://yesfree.us/api/v1/links/{id}
Request example:
curl --location --request GET 'https://yesfree.us/api/v1/links/{id}' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}'
API endpoint:
https://yesfree.us/api/v1/links
Request example:
curl --location --request POST 'https://yesfree.us/api/v1/links' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'url={url}' \ --data-urlencode 'domain={id}'
url
domain_id
alias
password
space_id
pixel_ids
disabled
0
for Active, 1
for Disabled. Defaults to: 0
.privacy
0
for Public, 1
for Private, 2
for Password. Defaults to: 0
.privacy_password
privacy
set to 2
.expiration_url
expiration_date
YYYY-MM-DD
format.expiration_time
HH:MM
format.expiration_clicks
target_type
0
for None, 1
for Geographic, 2
for Platform, 4
for Rotation.country[index][key]
country[index][value]
platform[index][key]
iOS
, Android
, Windows
, OS X
, Linux
, Ubuntu
, Chrome OS
.platform[index][value]
language[index][key]
language[index][value]
rotation[index][value]
API endpoint:
https://yesfree.us/api/v1/links/{id}
Request example:
curl --location --request PUT 'https://yesfree.us/api/v1/links/{id}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'url={url}'
url
alias
password
space_id
pixel_ids
disabled
0
for Active, 1
for Disabled.privacy
0
for Public, 1
for Private, 2
for Password.privacy_password
privacy
set to 2
.expiration_url
expiration_date
YYYY-MM-DD
format.expiration_time
HH:MM
format.expiration_clicks
target_type
0
for None, 1
for Geographic, 2
for Platform, 4
for Rotation.country[index][key]
country[index][value]
platform[index][key]
iOS
, Android
, Windows
, OS X
, Linux
, Ubuntu
, Chrome OS
.platform[index][value]
language[index][key]
language[index][value]
rotation[index][value]
API endpoint:
https://yesfree.us/api/v1/links/{id}
Request example:
curl --location --request DELETE 'https://yesfree.us/api/v1/links/{id}' \ --header 'Authorization: Bearer {api_key}'