Skip to main content
GET
/
points
/
balance
Get points balance
curl --request GET \
  --url https://api.sprucecollective.co.uk/points/balance \
  --header 'Authorization: <api-key>'
{
  "available_points": 123,
  "expired_points": 123,
  "pending_points": 123,
  "point_items": [
    {
      "created_at": "<string>",
      "item_id": "<string>",
      "payment_transaction_id": "<string>",
      "point_id": "<string>",
      "purchase_cost_cents": 123,
      "purchase_currency": "<string>",
      "quantity": 123
    }
  ],
  "total_points": 123,
  "user_id": "<string>"
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Response

OK

available_points
integer
expired_points
integer
pending_points
integer
point_items
object[]
total_points
integer
user_id
string