CLcloudblue
Agreements

GET /agreements/{agreement_id}/partners

Changed on

Request

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

Path parameters

agreement_idstring required

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

agreement.namestring

Filter for: agreement.name

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

ordering: true

contract.idstring

Filter for: contract.id

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

contract.status'new' | 'enrolling' | 'pending' | 'active' | 'terminated' | 'rejected'

Filter for: contract.status

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

ordering: true

contract.versioninteger

Filter for: contract.version

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

ordering: true

events.countersigned.atstring date-time

Filter for: events.countersigned.at

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

ordering: true

default: hidden

events.countersigned.by.idstring

Filter for: events.countersigned.by.id

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

ordering: true

default: hidden

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

events.signed.atstring date-time

Filter for: events.signed.at

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

ordering: true

default: hidden

events.signed.by.idstring

Filter for: events.signed.by.id

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

ordering: true

default: hidden

idstring

Filter for: id

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

namestring

Filter for: name

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

ordering: true

role'vendor' | 'distributor' | 'reseller'

Filter for: role

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

ordering: true

Response

idstring
namestring
iconstring binary
rolestring

Changes

  • 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

  • 22a697bcb678Revision 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