Layouts

List all layouts

Changed on

Retrieves a list of layouts with optional filtering and pagination

get/v2/layouts

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Query parameters

limitnumber
Example:10

Number of items to return per page

offsetnumber

Number of items to skip before starting to return results

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBy'createdAt' | 'updatedAt' | 'name'

Field to sort the results by

querystring

Search query to filter layouts

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

totalCountnumber required

Total number of layouts

Changes

    • breaking

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

    • breaking

      the response property /////// became optional for the status

    • breaking

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

    • info

      removed from the /////// response property allOf list for the response status