---
title: "Returns the specified contract."
method: GET
path: "/contracts/{contract_id}"
tags: ["contracts"]
---

# Returns the specified contract.

`GET /contracts/{contract_id}`

You need to be a member of specified contract or a user with `TenantAdmin` role to access this resource.

To make custom data to be included in a response, a user must have `contracts.contract.get_custom_data` permission.

## Path parameters

- `contract_id` string, required

## Query parameters

- `include` 'members' | 'invites' | 'members,invites'

## Response `200`

OK

- object
  - `data` object, required
    - `id` string, required
    - `type` 'contract', required — Allowed value: `contract`
    - `links` object, required
      - `self` string, required
    - `attributes` object, required
      - `name` string, required — Name of the contract
      - `type` 'full' | 'trial' — Type of the contract.
      - `created_at` string — Shows the creation date of a contract.
      - `updated_at` string — Shows the date of last update made to the contract.
      - `available_roles` object[]
        - `scope` 'contracts' | 'workspaces', required — The role's scope
        - `role` string, required — The role's name
      - `status` string
      - `flow_stats_enabled_default` boolean
      - `support_user_id` string — An identifier of user from platform support team
      - `custom_data` object — Custom contract data in an arbitrary format. This field is **not intended to store sensitive data**. Max size after stringify is 1 MB
      - `feature_flags` object
        - `disable_recipe_feature` boolean — Disable ability to change existing recipes or create new ones
        - `subscribe_to_error_by_default` boolean — Subscribe to error notifications from flows by default. Default: "true"
    - `relationships` object, required
      - `members` object, required
        - `data` object[], required
          - `id` string, required
          - `type` 'contract-member', required
        - `links` object, required
          - `self` string, required
      - `workspaces` object, required
        - `data` object[], required
          - `id` string, required
          - `type` 'workspace', required
      - `invites` object, required
        - `data` object[], required
          - `id` string, required
          - `type` 'contract-invite', required
        - `links` object, required
          - `self` string, required
  - `meta` object, required
  - `included` union[], required
    - union
      - object
        - `id` string, required
        - `type` 'contract-member', required
        - `attributes` object, required
          - `first_name` string, required
          - `last_name` string, required
          - `roles` string[], required
          - `email` string, required
        - `relationships` object, required
          - `user` object, required
            - `data` object, required
              - …
            - `links` object, required
              - …
      - object
        - `id` string, required
        - `type` 'contract-invite', required
        - `attributes` object, required
          - `email` string, required
          - `roles` string[], required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/elastic/apis/elastic-io-rest-api-documentation-v2.md) · [All operations](https://skmtc.net/elastic/apis/elastic-io-rest-api-documentation-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/elastic-io-rest-api-documentation-v2/revisions/411f9f98c01e/schema)