List ReadyLinks

Returns paginated list of the user’s ReadyLinks, with filtering, sorting, and pagination. Feature-gated on the multiReadyLink flag. Returns 403 FEATURE_NOT_AVAILABLE if disabled.

GET /api/agent/readylinks

List ReadyLinks

cURL

curl --request GET \
  --url https://app.auditynow.com/api/agent/readylinks \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.auditynow.com/api/agent/readylinks"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.auditynow.com/api/agent/readylinks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.auditynow.com/api/agent/readylinks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.auditynow.com/api/agent/readylinks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.auditynow.com/api/agent/readylinks")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/agent/readylinks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "readylinks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "name": "<string>",
        "fullUrl": "<string>",
        "isActive": true,
        "leadCount": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "assessmentConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assessmentConfigName": "<string>",
        "bookingLink": "<string>",
        "consultantName": "<string>",
        "consultantCompany": "<string>",
        "consultantLogo": "<string>",
        "customDescription": "<string>",
        "customDomain": "<string>"
      }
    ],
    "pagination": {
      "total": 123,
      "limit": 123,
      "offset": 123
    },
    "tierLimit": 123,
    "activeCount": 123
  }
}

{
  "error": "Unauthorized"
}

{
  "error": "Feature not available",
  "code": "FEATURE_NOT_AVAILABLE"
}

{
  "error": "<string>",
  "details": "<string>"
}

Authorizations

Authorization · string · header · required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Query Parameters

limit · integer · default: 50

Required range: 1 <= x <= 500

offset · integer · default: 0

Required range: x >= 0

sortBy · enum<string> · default: created_at

Available options: created_at, updated_at, name, is_active

sortOrder · enum<string> · default: desc

Available options: asc, desc

isActive · boolean · default: true

Response

200

application/json

Paginated ReadyLinks

data · object · required

Show child attributes