v51

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-01131107332.8 KB

Contracts

Search contracts

Searches for artifacts that have contract metadata labels. Filters by status, owner team, and compatibility group.

get/search/contracts

Query parameters

statusstring

Filter by contract status (DRAFT, STABLE, DEPRECATED).

ownerTeamstring

Filter by owner team.

compatibilityGroupstring

Filter by compatibility group.

offsetinteger

Number of results to skip.

limitinteger

Maximum number of results to return.

order'asc' | 'desc'

Sort order (asc or desc).

orderby'name' | 'createdOn' | 'modifiedOn'

Field to sort by.

Response

A paginated list of artifacts that have contract metadata.

countinteger required

The total number of artifacts that matched the query that produced the result set (may be more than the number of artifacts in the result set).

Example response

{
  "artifacts": [
    {
      "groupId": "My-Group",
      "artifactId": "Procurement-Invoice",
      "name": "Artifact Name",
      "description": "Description of the artifact",
      "artifactType": "AVRO",
      "owner": "user1",
      "createdOn": "2019-03-22T12:51:19Z",
      "modifiedBy": "user2",
      "modifiedOn": "2019-04-01T12:51:19Z"
    }
  ]
}