Retreive all Bitsy Links - Bitsy Documentation

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

title

string

Title of the link or any of the link tags, optional.

Maximum length: 150

is_clicked

enum<string>

Indicates if the link has been clicked.

Available options:

true,

false

has_password

enum<string>

Indicates if a password is required to access the link.

Available options:

true,

false

start_date

string

Start date for filtering links. Must be in 'YYYY-MM-DD' format.

end_date

string

End date for filtering links. Must be in 'YYYY-MM-DD' format.

offset

string

Offset for pagination.

limit

string

Limit for pagination.

Response

200 - application/json

data

object

required

data.links

object[]

data.links.android_target_url

string

Target URL for Android devices.

data.links.bitsy_url

string

The shortened URL generated for the Bitsy Link.

data.links.created_at

string

The timestamp indicating when the Bitsy Link was created.

data.links.custom_link

string

Custom slug for the link, between 3 and 50 characters.

Required string length: 3 - 50

data.links.custom_url

string

The custom URL provided for the shortened link, if applicable.

data.links.expiration

string

Expiration date for the link in ISO 8601 format.

data.links.expiration_clicks

string

Maximum number of clicks before the link expires.

data.links.favicon

string

URL of the favicon for the link.

data.links.geo_targets

object[]

Array of geo-targeting rules.

data.links.has_android_targeting

boolean

Indicates if there is a target URL for Android.

data.links.has_cloaking

boolean

Indicates if cloaking is enabled.

data.links.has_expiration

boolean

Indicates if the link has an expiration date or expiration clicks.

data.links.has_geo_targeting

boolean

Indicates if geo-targeting is used.

data.links.has_ios_targeting

boolean

Indicates if there is a target URL for iOS.

data.links.has_linux_targeting

boolean

Indicates if there is a target URL for Linux.

data.links.has_opengraph

boolean

Indicates if OpenGraph metadata is included.

data.links.has_password

boolean

Indicates if a password is required to access the link.

data.links.has_utm

boolean

Indicates if UTM parameters are used.

data.links.has_windows_targeting

boolean

Indicates if there is a target URL for Windows.

data.links.id

string

The ID of the Bitsy Link.

data.links.ios_target_url

string

Target URL for iOS devices.

data.links.is_clicked

boolean

Indicates whether the shortened URL has been clicked at least once.

data.links.is_expired

boolean

Indicates whether the shortened URL has expired and is no longer valid.

data.links.last_clicked

string

The timestamp of the last time the shortened URL was clicked.

data.links.linux_target_url

string

Target URL for Linux devices.

data.links.long_url

string

The long URL that the shortened link will redirect to.

data.links.opengraph

object

data.links.password_logo

string

URL of the logo to display on the password prompt.

data.links.shareable_analytics

object[]

data.links.tags

string[]

Array of tags associated with the link.

data.links.title

string

Title of the link, up to 150 characters.

Maximum length: 150

data.links.utm

object

data.links.windows_target_url

string

Target URL for Windows devices.

status

enum<string>

required

Available options:

success

API Documentation

Bitsy Link

Authorizations

Query Parameters

Response