latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Design

Search Designs

Returns the organizations Designs in paginated format. The pagination is handled with the startIndex and length keys in the request body. There are two filtering options within the body:

  • type field is used for filtering between certificate and badge designs
    • 1 -> certificate
    • 2 -> badge
  • searchTerm field is searched within the titles of the designs

The preview field in the response will contain the HTML of the design.

post/design/search

Headers

api-versionstring required

The API version. Current version is 3.3. This value has to be set in every request.

Request body

startIndexinteger
lengthinteger
typeinteger

1 = certificate, 2 = badge

searchTermstring

Response

Successful response

messagestring nullable
hasErrorboolean
validationErrorsstring[]
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","nullable":true}