Components

List of Components Paginated

Ordering

The file list is order by created_at descending. You can override the ordering through the ordering query parameter with the following fields:

  • created_at
  • updated_at
  • name

Fields are ordered as ascending by default and you can change it to descending by adding - before the field, eg -created_at

Here are a few examples to update the file list ordering.

Order by creation date, ascending

/api/v1/user/components_paginated/?ordering=created_at

Order by creation date, descending

/api/v1/user/components_paginated/?ordering=-created_at

You can also order by multiple fields separating by comma

/api/v1/user/components_paginated/?ordering=-created_at,name

Pagination

This endpoint is paged to 30 results per page. You can override the page size with the page_size query parameter. You can also override the page number with the page query parameter.

/api/v1/user/components_paginated/?page_size=20&page=2
get/user/components_paginated/

Request

  • Base URL
    http://api.cannoli.app/api/v1
  • Auth
    none declared

Query parameters

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

OK

countinteger required
nextstring uri nullable
previousstring uri nullable

Changes

No recorded changes to this operation across all 1 revision of this API.