v1

latestOpenAPI 3.1.02026-07-231411067.5 KB
Contracts

List contracts

This endpoint allows you to list contracts in your organization.

This GET is a paginated API that uses the following parameters to request specific details:

  • size: Supply an integer value between 10 and 1000, inclusive. The default value is 10.

  • page: Supply an integer value. The default value is 0.

  • datasetId: Optionally, use this parameter to list only the contracts for a specific dataset.

  • datasetQualifiedName: Optionally, use this parameter instead of datasetId to identify the dataset by its qualified name. Do not supply both datasetId and datasetQualifiedName.

Authorization

When filtering by dataset, only users with View dataset permission on the specified dataset can list its contracts. When no dataset filter is supplied, all contracts in the organization are returned.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Tags

Contracts

Rate limiting

60 requests/60 seconds

get/api/v1/contracts

Query parameters

datasetIdstring
datasetQualifiedNamestring
pageinteger
sizeinteger

Response

Successful response

firstboolean required
lastboolean required
numberinteger required
sizeinteger required
totalElementsinteger required
totalPagesinteger required