# Get Link Status

Get the status of a given link.

Endpoint: GET /v1/links/status
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Query parameters:

  - `url` (string)
    The URL of the link. Provide either 'url' or 'id'.
    Example: "https://bookings.herohealth.net/s/abc123"

  - `id` (string)
    The ID of the short link. Provide either 'url' or 'id'.
    Example: "12345"

## Response 200 fields (application/json):

  - `status` (string, required)
    Enum: "unused", "used", "partially_used", "expired", "disabled"

  - `type` (string, required)
    Enum: "booking", "questionnaire", "attachment", "patient_reply", "video"

  - `reference` (array)

  - `reference.id` (string, required)

## Response 400 fields (application/json):

  - `error` (boolean, required)

  - `statusCode` (number, required)

  - `message` (array, required)

  - `message.code` (string, required)

  - `message.expected` (string, required)

  - `message.path` (array, required)


## Response 401 fields

## Response 422 fields

## Response 500 fields