Skip to main content
GET
/
usage_records
/
{usage_record}
Retrieve an usage record
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/usage_records/{usage_record} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<id>",
  "object": "usage_record",
  "data": {
    "company": {
      "id": "<id>",
      "object": "company",
      "links": {
        "self": "/companies/<id>"
      }
    },
    "event": "employee_paid",
    "record": {
      "id": "<id>",
      "object": "pay_stub",
      "links": {
        "self": "/pay_stubs/fake-id"
      }
    },
    "recorded_at": "2026-01-01 00:00:00",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/usage_records/<id>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

usage_record
string
required

Response

200 - application/json

OK

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

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

data
Usage Record · object