Get Shortlink Details

GET

/api/v1/shortlinks/{link_key}

const url = 'https://dashboard.dealerstudio.com.au/api/v1/shortlinks/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.dealerstudio.com.au/api/v1/shortlinks/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

link_key

required

string

Shortlink key

Responses

200

Retrieves shortlink by link_key

application/json

object

link_key

required

string

destination_url

required

string

dealership_id

required

integer

website_id

integer

nullable

Example

{
  "link_key": "abc123",
  "destination_url": "https://example.com/destination",
  "dealership_id": 1,
  "website_id": 1
}

401

Unauthorized - Missing show:shortlink permission

404

Shortlink not found

application/json

object

error

required

string

Example

{
  "error": "Shortlink not found"
}