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>'

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
  }
}

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