---
title: "GET /contracts"
method: GET
path: "/contracts"
tags: ["Contract Vault"]
---

# GET /contracts

`GET /contracts`

Retrieves contract vault records based on provided criteria.

## Query parameters

- `startTimestamp__lte` string, date-time
- `startTimestamp__gte` string, date-time
- `endTimestamp__lte` string, date-time
- `endTimestamp__gte` string, date-time
- `id__in` string
- `layoutId` string
- `agentFirstName__in` string[]
- `agentFirstName__contains` string
- `agentLastName__in` string[]
- `agentLastName__contains` string
- `agentEmail__in` string[]
- `agentEmail__contains` string
- `managerFirstName__in` string[]
- `managerFirstName__contains` string
- `managerLastName__in` string
- `managerLastName__contains` string
- `customerFirstName__in` string[]
- `customerFirstName__contains` string
- `customerLastName__in` string[]
- `customerLastName__contains` string
- `stockNumber__in` string
- `pageToken` string
- `pageSize` integer

## Response `200`

Successful retrieval of contract records.

- ContractList — Used to wrap results for a paginated response, containing information on how to retrieve further pages.
  - `nextPageToken` string, nullable, required — Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.
  - `prevPageToken` string, nullable, required — Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.
  - `results` object[], required — The result set from a collection API call.
    - `id` string, required — Unique identifier for the recording.
    - `customers` object[], required — List of customer names associated with the recording. A primary and secondary customer may be present.
      - `firstName` string, required — First name of the customer.
      - `lastName` string, required — Last name of the customer.
      - `primary` boolean, required — Indicates if this customer is the primary contact.
    - `agent` object, required — Information about the agent associated with the recording.
      - `firstName` string — First name of the agent.
      - `lastName` string — Last name of the agent.
      - `email` string, email — Email address of the agent.
    - `manager` object — Information about the manager associated with the recording.
      - `firstName` string — First name of the manager.
      - `lastName` string — Last name of the manager.
    - `extStockNumber` string — Stock number associated with the recording.
    - `extContractNumber` string — Contract number associated with the recording.
    - `extServiceEntity` string — The service entity associated with the recording.
    - `videoAvailable` boolean, required — Indicates if the video is available.
    - `noVideoReason` 'equipmentOrCommunicationFailure' | 'ownerRefusedConsent' | 'noRoomAvailable' | 'noQaAvailable' | 'noVloAvailable' | 'recording' | 'medical' | 'unspecified' | 'other' — Reason for not having a video.
    - `video` object — Video metadata including URL and other details.
      - `durationSec` string, required — Length of the video recording.
      - `startTimestamp` string, date-time, required — Start time of the video recording in ISO 8601 format.
      - `endTimestamp` string, date-time, required — End time of the video recording in ISO 8601 format.
    - `cameraIds` string[] — Unique identifiers for the cameras used in the recording.
    - `layoutId` string — Unique identifier for the layout used in the recording.
    - `updateTimestamp` string, date-time — Date and time when the record was last updated.

## Other responses

- `400` — The supplied object is invalid. Error detail will contain the validation error.
- `401` — You are not authenticated. Please authenticate and try again.
- `403` — You have no permission to access the specified resource.
- `500` — Something went wrong in the server. Please try again.

---

[API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)