GET
/
links

Authorizations

Authorization
string
headerrequired

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
status
enum<string>
required
Available options:
success
data
object
required

Was this page helpful?

Retreive a Bitsy LinkUpdate Bitsy Link