CLcloudblue
Agreements

GET /forms

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.

events.created.atstring date-time

Filter for: events.created.at

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

ordering: true

idstring

Filter for: id

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

search: true

ordering: true

namestring

Filter for: name

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

search: true

ordering: true

type'enroll' | 'product' | 'item'

Filter for: type

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

search: true

ordering: true

Response

idstring
versioninteger
namestring required
type'enroll' | 'product' | 'item'
statusstring
schemaobject required

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 required property / to the response with the status

    • info

      added the required property / to the response with the status

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

    • 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