Partners

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.

audience'private' | 'vendor' | 'reseller' | 'distributor' | 'any'

Filter for: audience

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

ordering: true

contentstring

Filter for: content

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

search: true

creator.idstring

Filter for: creator.id

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

search: true

creator.namestring

Filter for: creator.name

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

search: true

events.created.atstring date-time

Filter for: events.created.at

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

ordering: true

events.drafted.atstring date-time

Filter for: events.drafted.at

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

ordering: true

events.published.atstring date-time

Filter for: events.published.at

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

ordering: true

events.updated.atstring date-time

Filter for: events.updated.at

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

ordering: true

external_idstring

Filter for: external_id

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

search: true

idstring

Filter for: id

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

status'draft' | 'published' | 'deleted'

Filter for: status

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

ordering: true

subtitlestring

Filter for: subtitle

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

search: true

titlestring

Filter for: title

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

search: true

Response

idstring
namestring nullable
external_idunknown
status'draft' | 'published' | 'deleted'
audience'private' | 'vendor' | 'reseller' | 'distributor' | 'any'
anonymousboolean nullable
versioninteger required
titlestring required
subtitlestring required
contentstring required

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 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

    • 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

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the 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