INinfomaniak
Radio Products

List products

Changed on

This endpoint allows you to retrieve all the products.

get/1/radios

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/radios
  • Auth
    HTTP bearer

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

account_idinteger required

Specify the account

The account identifier

order_bystring[]

the field to order the result by

order_forstring[]

the direction of the sort

pageinteger
per_pageinteger
searchstring

the field to search the stat by

Example:test
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

limitinteger

Optional parameter that define the number of items to return<br /> Part of the offset capacity

skipinteger

Optional parameter that define the index of the first item to return (0 = first item)<br /> Part of the offset capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

string
OR
string[]

Optional parameter that define the field used for sorting<br /> Part of the sort capacity

order'asc' | 'desc'

Optional parameter that define the default sort order<br /> Part of the sort capacity

order_forobject

Optional parameter that define the sorting order for a field<br /> By default order is used<br /> Part of the sort capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Changes

  • 96ca7c8a0545Revision changes
    • warning

      deleted the query request parameter order_by

    • warning

      deleted the query request parameter order_for

    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter per_page

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter order_for

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

  • 0cd8a60951f5Revision changes
    • warning

      deleted the query request parameter order_by

    • warning

      deleted the query request parameter order_for

    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter per_page

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter order_for

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page