# Get Links

Get paginated list of Travel Details Links.

> {% icon name="solid circle-info" size="2em" color="var(--admonition-warning-icon-color)" /%} Requires access to customer.travel_detail_link.manage feature .

Optionally, Travel Details Links can be filtered by different fields. \
Some of the fields support advance filtering: \
reference_id, trip_name fields support like and = operators. \
start_date, end_date and created_at fields support =, > operators.

Eg: Wildcard (%) search:
json
{
  "reference_id": {"like": "REF-12%"}
}

Eg: Exact match:
json
{
  "trip_name": {"=": "Summer Trip"}
}

Eg: date field operators:
json
{
  "start_date": {
    ">=": "2026-01-01"
    "<=": "2026-12-31"
  }
}

Endpoint: POST /travel-details
Version: 2.0.0
Security: oAuth, bearerAuth

## Request fields (application/json):

  - `status` (string)
    Get only links that are unseen (not visited by traveller) or seen.
    Enum: "unseen", "seen"

  - `tid` (string)
    Search link by Travel ID.
    Example: "ABCD-EFGH-IJKL"

  - `reference_id` (any)

  - `trip_name` (any)

  - `destinations` (array)
    Get links that were created for provided destinations.

  - `nationalities` (array)
    Get links that were created for provided nationalities.
    Example: ["DE","AT"]

  - `start_date` (object)

  - `start_date.<` (string)
    Example: "2025-01-01"

  - `start_date.<=` (string)
    Example: "2025-01-01"

  - `start_date.=` (string)
    Example: "2025-01-01"

  - `start_date.>=` (string)
    Example: "2025-01-01"

  - `start_date.>` (string)
    Example: "2025-01-01"

  - `end_date` (object)

  - `created_at` (object)

  - `sort_by` (string)
    Enum: "created_at", "start_date"

  - `sort_order` (string)
    Enum: "asc", "desc"

  - `page` (integer)
    Specify page number to retrieve records of a particular page.

  - `per_page` (integer)
    Number of records that should be returned in response.
    Example: 100

## Response 200 fields (application/json):

  - `data` (array)

  - `data.tid` (string)
    Example: "ABCD-EFGH-IJKL"

  - `data.reference_id` (string,null)
    Example: "REF-123"

  - `data.trip_name` (string)
    Example: "Trip Name"

  - `data.destinations` (array)
    Example: ["TR","ZA","AE"]

  - `data.nationalities` (array)
    Example: ["DE","AT"]

  - `data.start_date` (string)
    Example: "2025-01-01"

  - `data.end_date` (string)
    Example: "2025-01-07"

  - `data.tour_operators` (array)
    Tour operator content will be displayed on the travel details link for records with the given codes.
    Example: ["tour_operator_1","tour_operator_2"]

  - `data.individual_contents` (array)
    Individual content sections will be displayed on the travel details link for the given codes.
    Example: ["individual_content_section_1","individual_content_section_2"]

  - `data.cover_media` (string,null)
    Travel detail link will show a cover media which has the given UUID.

  - `data.note` (string,null)
    Example: "A note about the trip."

  - `data.visits` (integer)

  - `data.last_visited_at` (string)
    Example: "2025-01-01 00:00:00"

  - `data.last_important_change_at` (string)

  - `data.created_at` (string)

  - `links` (object)

  - `links.first` (string)

  - `links.prev` (string)

  - `links.next` (string)

  - `links.last` (string)

  - `meta` (object)

  - `meta.per_page` (number)

  - `meta.current_page` (number)

  - `meta.from` (number)

  - `meta.to` (number)

  - `meta.total` (number)

  - `meta.last_page` (number)

  - `meta.path` (string)

  - `requestid` (string)
    Unique Request ID identifying this request.

  - `responsetime` (number)
    Time taken to generate response.