Sign in
Library

List currencies

get/library/currencies

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/library/currencies
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

withCountboolean

Include the total number of matching items. Defaults to false.

qstring

Search currency names and codes.

includeDeletedboolean

Include deleted currencies.

Response

A page of workspace currencies.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching items; present only when withCount=true was requested.

truncatedboolean

Whether some matching items were omitted from the response.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e"
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.