Skip to main content
GET
/
currencies
Retrieve Currencies
curl --request GET \
  --url https://api.nuwebgroup.com/v1/currencies \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "currencies",
      "id": 1,
      "attributes": {
        "name": "Pounds",
        "symbol": "Ā£",
        "subunit": "2",
        "isCashless": true,
        "isCustom": false
      }
    }
  ],
  "links": {
    "first": "http://api.willms.com/v1/currencies?page=1",
    "last": "http://api.willms.com/v1/currencies?page=5",
    "prev": "http://api.willms.com/v1/currencies?page=2",
    "next": "http://api.willms.com/v1/currencies?page=5",
    "self": "http://api.willms.com/v1/currencies?page=3"
  },
  "meta": {
    "total": 4
  }
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
page
integer

The page you wish to retrieve currencies.

ā€‹
limit
integer

The number of currencies to retrieve per page. The maximum (and default) is 100 per page.

ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. currencies.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. currencies.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successfully retrieved the currencies.

ā€‹
data
object[]
ā€‹
links
object
ā€‹
meta
object
ā€‹
included
object[]