---
title: "Get Service Contracts"
method: GET
path: "/v2/customer_portal/service_contracts"
---

# Get Service Contracts

`GET /v2/customer_portal/service_contracts`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/v2/customer_portal/service_contracts`
- Auth: API key in header `x-api-key`

## Query parameters

- `page` string, required
- `count` integer, required
- `sort` 'DESC' | 'ASC'
- `sort_by` 'contract_name' | 'contract_number' | 'end_date' | 'created_at'
- `filter.keyword` string
- `filter.end_date_from` string, date, required
- `filter.end_date_to` string, date, required
- `filter.asset_uid` string
- `filter.job` string
- `filter.property` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `prefix` string
    - `contract_uid` string
    - `customer` object
      - `customer_uid` string
      - `customer_first_name` string
      - `customer_last_name` string
      - `customer_company_name` string
      - `customer_email` string
      - `customer_contact_no` object
        - `mobile` string
        - `home` string
        - `work` string
      - `is_active` boolean
      - `is_deleted` boolean
    - `organization` object
      - `organization_uid` string
      - `organization_name` string
      - `organization_email` string
      - `no_of_customers` integer
    - `properties` unknown
    - `assets` unknown[]
      - unknown
    - `ref_no` string
    - `contract_name` string
    - `start_date` string
    - `end_date` string
    - `term_months` integer
    - `activation_date` unknown
    - `approval_status` string
    - `await_approval_by` unknown
    - `custom_fields` object[]
      - `label` string
      - `value` string
      - `type` string
      - `module_name` string
      - `hide_to_fe` boolean
      - `hide_field` boolean
      - `read_only` boolean
      - `_id` string
    - `invoice_settings` object
      - `auto_generate` boolean
      - `send_to_customer` boolean
      - `billing_period` object
        - `billing_period_uid` string
        - `billing_period_name` string
        - `billing_period_type` string
        - `billing_period_value` integer
        - `is_deleted` boolean
        - `is_active` boolean
      - `generate_invoice_days` integer
      - `payment_term` object
        - `payment_term_name` string
        - `no_of_days` integer
        - `payment_term_uid` string
      - `invoice_template` object
        - `template_name` string
        - `template_description` string
        - `type` string
        - `template_uid` string
    - `contract_subtotal` integer
    - `contract_total` integer
    - `is_active` boolean
    - `is_expired` boolean
    - `is_deleted` boolean
    - `created_at` string
    - `updated_at` string
    - `contract_number` integer
  - `current_page_records` integer
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/v2/customer_portal/service_contracts/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)