Accounts28

ACL6

Agreements32

Assets21

Auth16

Brands4

Catalog10

Contracts21

Conversations8

Custom Attributes11

Customers12

DevOps86

Domains13

Embedded Listings2

Extensions31

Files7

General Collections10

Guidelines7

Helpdesk16

Hubs7

InternalTaskContexts2

Leads12

Listings15

Localization23

Marketplaces8

Metrics1

MfaMethods3

Mfas6

Notification Rules7

Notification settings3

Offers56

Offers Attributes Forms2

Offers Blueprints14

Offers Presets4

Partners13

PIM57

Portals6

PresetVersions7

Pricing20

Private Offers11

Products88

Reports27

Settings16

SLM5

Statistics4

Streams60

Subscriptions10

Usage Reporting40

User17

ValidatePayloads1

Contracts

GET /contracts

Changed on May 17, 2025

Request

Base URL
https://api.connect.cloudblue.com/public/v1
Auth
API key in header Authorization

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

agreement.idstring

Filter for: agreement.id

lookups: eq, ne, like, ilike, null, in, out

search: true

agreement.namestring

Filter for: agreement.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

agreement.owner.idstring

Filter for: agreement.owner.id

lookups: eq, ne, like, ilike, null, in, out

agreement.product_groups.idstring

Filter for: agreement.product_groups.id

lookups: eq, ne, like, ilike, null, in, out

agreement.product_groups.products.idstring

Filter for: agreement.product_groups.products.id

lookups: eq, ne, like, ilike, null, in, out

agreement.sourcing_agreement.idstring

Filter for: agreement.sourcing_agreement.id

lookups: eq, ne, like, ilike, null, in, out

agreement.sourcing_agreement.type'distribution' | 'program' | 'service' | 'syndication' | 'referral'

Filter for: agreement.sourcing_agreement.type

lookups: eq, ne, like, ilike, in, out

agreement__idstring

Filter for: agreement__id

lookups: eq, ne, like, ilike, null, in, out

agreement__namestring

Filter for: agreement__name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

agreement__owner__idstring

Filter for: agreement__owner__id

lookups: eq, ne, like, ilike, null, in, out

events.created.atstring date-time

Filter for: events.created.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.created.by.idstring

Filter for: events.created.by.id

lookups: eq, ne, like, ilike, null, in, out

events.created.by.namestring

Filter for: events.created.by.name

lookups: eq, ne, like, ilike, null, in, out

search: true

events.signed.by.idstring

Filter for: events.signed.by.id

lookups: eq, ne, like, ilike, null, in, out

events.signed.by.namestring

Filter for: events.signed.by.name

lookups: eq, ne, like, ilike, in, out

search: true

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

issuer.idstring

Filter for: issuer.id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

issuer.namestring

Filter for: issuer.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

kind'production' | 'test'

Filter for: kind

lookups: eq, ne, like, ilike, in, out

marketplace.idstring

Filter for: marketplace.id

lookups: eq, ne, like, ilike, null, in, out

search: true

marketplace.namestring

Filter for: marketplace.name

lookups: eq, ne, like, ilike, in, out

search: true

marketplace__idstring

Filter for: marketplace__id

lookups: eq, ne, like, ilike, null, in, out

marketplace__namestring

Filter for: marketplace__name

lookups: eq, ne, like, ilike, in, out

search: true

owner.idstring

Filter for: owner.id

lookups: eq, ne, like, ilike, null, in, out

owner.namestring

Filter for: owner.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

owner__idstring

Filter for: owner__id

lookups: eq, ne, like, ilike, null, in, out

owner__namestring

Filter for: owner__name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

partner.idstring

Filter for: partner.id

lookups: eq, ne, like, ilike, null, in, out

referral.agreement.idstring

Filter for: referral.agreement.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.listing.idstring

Filter for: sourcing.listing.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.marketplace.idstring

Filter for: sourcing.marketplace.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.marketplace.namestring

Filter for: sourcing.marketplace.name

lookups: eq, ne, like, ilike, in, out

sourcing.product.idstring

Filter for: sourcing.product.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.product.namestring

Filter for: sourcing.product.name

lookups: eq, ne, like, ilike, in, out

Filter for: status

lookups: eq, ne, like, ilike, in, out

ordering: true

type'distribution' | 'program' | 'service' | 'syndication' | 'referral'

Filter for: type

lookups: eq, ne, like, ilike, in, out

Response

idstring

typestring

versioninteger nullable

statusstring

version_createdstring date-time nullable

namestring

enrolledstring date-time nullable

lateststring

kind'production' | 'test'

expire_atstring date-time nullable

notestring nullable

permissionsobject nullable

termination_notestring nullable

Changes

May 17, 20252de715cbd1f3 Revision changes
- breaking
  the response's property type changed from no type to object for status
- info
  added the new optional query request parameter limit
- info
  added the new optional query request parameter offset
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional write-only property items/permissions to the response with the status
Dec 1, 202322a697bcb678 Revision changes
- breaking
  the response's property type changed from object to no type for status
- warning
  deleted the query request parameter limit
- warning
  deleted the query request parameter offset
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  removed the optional write-only property items/permissions from the response with the status

Operation history (5 revisions)

GET /contracts

Request

Query parameters

Response 200OK

Changes

Response