CLcloudblue
Agreements

GET /agreements

Changed on

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.

action'enroll' | 'continue' | 'sign' | 'none'

Filter for: action

lookups: eq, ne, in

activeboolean

Filter for: active

lookups: eq, ne

agreements.action'enroll' | 'continue' | 'sign' | 'none'

Filter for: agreements.action

lookups: eq, ne, in

agreements.marketplace.idstring

Filter for: agreements.marketplace.id

lookups: eq, ilike, in

agreements.marketplace.namestring

Filter for: agreements.marketplace.name

lookups: eq, ilike

createdstring date-time

Filter for: created

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

ordering: true

forms.idstring

Filter for: forms.id

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

forms__type'enroll' | 'product' | 'item'

Filter for: forms__type

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

idstring

Filter for: id

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

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

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

titlestring

Filter for: title

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

search: true

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

Filter for: type

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

updatedstring date-time

Filter for: updated

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

ordering: true

Response

idstring
type'distribution' | 'program' | 'service' | 'syndication' | 'referral'
titlestring
namestring required
descriptionstring required
createdstring date-time
updatedstring date-time
document_type'external' | 'uploaded' | 'none'
linkstring uri
filestring binary nullable
activeboolean
auto_acceptboolean

Changes

  • 798ba51500b5Revision changes
    • info

      added the new optional query request parameter action

    • info

      added the new optional query request parameter agreements.action

    • info

      added the new optional query request parameter agreements.marketplace.id

    • info

      added the new optional query request parameter agreements.marketplace.name

  • 2de715cbd1f3Revision 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 write-only property items/active to the response with the status

    • info

      added the optional write-only property items/file to the response with the status

    • info

      added the optional write-only property items/link to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status