currencies

Requires an authenticated session.

Get currencies configured for this organization

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Currencies {
  currencies {
    id
    code
    name
    type
    createdAt
    decimalPlaces
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Currencies {\n  currencies {\n    id\n    code\n    name\n    type\n    createdAt\n    decimalPlaces\n  }\n}"
}
EOF

Response:

{
  "data": {
    "currencies": [
      {
        "id": "id",
        "code": "string",
        "name": "string",
        "type": "COMMODITY",
        "createdAt": "2025-01-15T00:00:00Z",
        "decimalPlaces": 0
      }
    ]
  }
}

currencies: [Currency!]!

Type

Currency object

A currency the organization can use.