Skip to main content
GET
/
organizations
/
{orgId}
/
balancehistory
/
List balance history for an organization
curl --request GET \
  --url https://dashboard.hologram.io/api/1/organizations/{orgId}/balancehistory/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 123,
  "size": 123,
  "continues": true,
  "lastid": 123,
  "links": {
    "path": "<string>",
    "base": "<string>",
    "next": "<string>"
  },
  "data": [
    {
      "id": 123,
      "orgid": 123,
      "amount": "<string>",
      "description": "<string>",
      "time": "<string>",
      "transaction_type_id": "<string>",
      "orderid": 123,
      "linkids": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Path Parameters

​
orgId
integer
required

Organization ID

Query Parameters

​
limit
integer
default:50

Maximum number of results to return (max 1000)

Required range: x <= 1000
​
before
integer

Return records with ID less than this value (cursor-based pagination)

​
after
integer

Return records with ID greater than this value (cursor-based pagination)

​
timestart
integer

Unix timestamp; return records from this time onward

​
timeend
integer

Unix timestamp; return records up to this time

​
startafter
integer

Return results with ID less than this value

​
tagid
integer

Filter by device tag ID

​
tagids
string

Comma-separated list of device tag IDs

​
tagname
string

Filter by device tag name

​
transactionTypeId
string

Filter by transaction type ID

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true

​
limit
integer
​
size
integer
​
continues
boolean
​
lastid
integer

ID of the last record returned, for cursor-based pagination

​
links
object
​
data
object[]