Show Apikey

GET

/api/v1/apikeys/apikey_details.json

const url = 'https://dashboard.dealerstudio.com.au/api/v1/apikeys/apikey_details.json';
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/apikeys/apikey_details.json \
  --header 'Authorization: Bearer <token>'

Returns the API key details for the authenticated token: the key id, its permissions, and the list of dealerships the key can access. Each dealership includes id, name, slug, locations (with id, name, location_type), and users (with id, name, email). Use this endpoint to obtain dealership and location identifiers when integrating with the Leads API or other Public API endpoints.

Authorizations

Bearer

Responses

200

Retrieves apikey

application/json

Examples

success

{
  "id": 1,
  "permissions": [
    "read:car"
  ],
  "dealerships": [
    {
      "id": 1,
      "name": "Dealership 1",
      "slug": "dealership-1",
      "locations": [
        {
          "id": 1,
          "name": "Location 1",
          "location_type": "sales"
        }
      ],
      "users": [
        {
          "id": 1,
          "name": "User 1",
          "email": "user1@example.com"
        }
      ]
    }
  ]
}

401

Unauthorized