# Get a list of customer contracts

Endpoint: GET /customer-contracts
Version: 1.11
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `id` (string)
    Filter by id
    Example: "0"

  - `name` (string)
    Filter by customer contract name
    Example: "xyz | in:x,y | like:xyz"

  - `customerId` (string)
    Filter by customer
    Example: "0"

  - `siteId` (string)
    Filter by site
    Example: "0"

  - `contractProfileId` (string)
    Filter by contract profile
    Example: "0"

  - `startDate` (string)
    Filter by start date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `endDate` (string)
    Filter by end date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `rolloverContractProfileId` (string)
    Filter by rollover contract profile
    Example: "0"

  - `renewalAlert` (string)
    Filter by contracts within renewal alert day(s)
    Example: "true | false"

  - `noticePeriod` (string)
    Filter by contracts within notice period alert day(s)
    Example: "true | false"

  - `filter` (string)
    Filter by text (Name, Assignment Level, Profile Name or Roll-over Profile Name)
    Example: "xyz | in:x,y | like:xyz"

  - `includeSupersededVersions` (string)
    Filter to include superseded i.e. old versions of the customer contract
    Example: "true | false"

  - `recentWithRPIsOrFuture` (string)
    If true, then return only customer contracts associated to RPIs that are 'recent', or customer contracts starting in the future
    Example: "true | false"

## Response 200 fields (application/json):

  - `id` (integer)
    Customer contract identifier
    Example: 1

  - `name` (string)
    Generated contract Name

  - `customerId` (integer, required)
    Customer identifier

  - `siteId` (integer)
    Site identifier to restrict contract to a particular site (optional)

  - `contractProfileId` (integer, required)
    Contract profile for this customer contract

  - `startDate` (string, required)
    Effective start date of the customer contract

  - `endDate` (string)
    Date when this customer contract ends based on start date and contract profile term

  - `createdDate` (string)
    Date when this customer contract was created

  - `rolloverContractProfileId` (integer)
    Once term of this contract ends, contract will auto-renew as this contract

  - `renewalAlertDays` (integer)
    Renewal alert will be given this many days before the contract ends

  - `noticePeriodDays` (integer)
    Notice period alert will be given this many days before the contract ends

  - `previousCustomerContractId` (integer)
    Where this contract had rolled-over from a previous contract, contains the previous contract

  - `renewedCustomerContractId` (integer)
    Where this contract rolled-over, contains the next contract that replaced this contract


## Response 400 fields

## Response 401 fields

## Response 404 fields

## Response 412 fields

## Response 500 fields

## Response 501 fields