Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

contracts

Lists all contracts for a specific user

You need to be a member of the Contract’s scope to access this resource.

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

get/contracts

Query parameters

page[size]integer

Amount of items per page

page[number]integer

Number of page you want to display

searchstring
Example:contractName

Search contracts by a word or a phrase contained in a title. Behavior is similar to operator LIKE in SQL. Case insensitive. Leading/following spaces are trimmed

Response

OK

Example response

{
  "data": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/contracts/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "name": "Contract name",
        "available_roles": [
          {
            "role": "admin"
          }
        ],
        "status": "active",
        "support_user_id": "5b4f337bff4304610483ba67",
        "feature_flags": {
          "disable_recipe_feature": true,
          "subscribe_to_error_by_default": true
        }
      },
      "relationships": {
        "members": {
          "data": [
            {
              "id": "5b4f337bff4304610483ba67"
            }
          ],
          "links": {
            "self": "/v2/contracts/5b4f337bff4304610483ba67/members"
          }
        },
        "workspaces": {
          "data": [
            {
              "id": "5b4f337bff4304610483ba67"
            }
          ]
        },
        "invites": {
          "data": [
            {
              "id": "5b4f337bff4304610483ba67"
            }
          ],
          "links": {
            "self": "/v2/contracts/5b4f337bff4304610483ba67/invites"
          }
        }
      }
    }
  ],
  "meta": {
    "page": 2,
    "per_page": 20,
    "total": 7,
    "total_pages": 2
  }
}