Skip to main content
GET
/
usage_summaries
List usage summaries
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/usage_summaries \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "usage_summary",
      "data": {
        "company": {
          "id": "<id>",
          "object": "company",
          "links": {
            "self": "/companies/<id>"
          }
        },
        "event": "employee_paid",
        "count": 0,
        "period_start": "2026-01-01",
        "period_end": "2026-01-31",
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/usage_summaries/<id>"
      }
    }
  ],
  "links": {
    "first": "/usage_summaries?page=1",
    "last": "/usage_summaries?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "has_more": false
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

OK

object
string
read-only

The type of the object in Nmbr ("list").

data
object[]