Start Today

← Documentation

Get Contract

The get contract API sends a GET request to return all contract information.

Authorization: API key (X-API-KEY).

Method / path: GET /api/v1/contracts/{id}

operationId: get_api-v1-contracts-id

Path parameters

NameRequiredFormat
idyesstring

Query parameters

NameRequiredFormat
enrichmentTypenoenum: HTTP, SOAP, DB_POLLER, CDC_AS400, SFTP, REVERSE, SERVERLESS, KAFKA, MQ, VSAM, ETL

Response

200 — contract payload for the requested id.

See also the contracts section and Create Contract.

Read more