# List Short links

Retrieves a list of shortlinks filtered by given parameters.

Endpoint: GET /v1/short_links
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `practiceGroupId` (unknown)
    apiKey in header x-practice-group-id

## Query parameters:

  - `page_index` (string)

  - `page_size` (string)

  - `order_by` (string)

  - `order_descending` (boolean)

  - `type` (string)

  - `status` (string)

  - `exclude_patient_specific_links` (boolean)

## Response 200:

  - `200` (unknown)
    Ok

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.link_name` (string, required)

  - `data.url` (string, required)

  - `data.status` (string, required)
    Enum: "expired", "unexpired"

  - `data.created_at` (string, required)

  - `data.expiry_date` (string, required)

  - `data.link_type` (string, required)
    Enum: "booking", "patient_reply", "questionnaire", "video", "attachment"

  - `data.linked_resource_type` (string, required)

  - `data.linked_resource_id` (number, required)

  - `data.meta` (object, required)

  - `data.meta.appointment_type_id` (array, required)

  - `data.meta.location_id` (array, required)

  - `data.meta.practitioner_id` (array)

  - `data.meta.from_date` (string)

  - `data.meta.to_date` (string)

  - `data.meta.room_token` (string)

  - `count` (number, required)

## Response 400:

  - `400` (unknown)
    Validation error

## Response 400 fields (application/json):

  - `error` (boolean, required)
    Example: true

  - `statusCode` (number, required)
    Example: 400

  - `message` (array, required)

  - `message.code` (string, required)
    Example: invalid_type

  - `message.expected` (string, required)
    Example: string

  - `message.path` (array, required)
    Example: ["patient_id"]

  - `message.message` (string, required)
    Example: Required

## Response 401:

  - `401` (unknown)
    Unauthorised

## Response 404:

  - `404` (unknown)
    Not found

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 500:

  - `500` (unknown)
    Unknown error