Skip to main content
GET
Get credit statement

Authorizations

x-api-key
string
header
required

Query Parameters

fromDate
string

Inclusive start of the window, ISO 8601. Defaults to 30 days before toDate. The window may span at most 366 days.

Example:

"2026-10-01T00:00:00Z"

toDate
string

Inclusive end of the window, ISO 8601. Defaults to now.

Example:

"2026-10-31T23:59:59Z"

limit
string
default:50

Rows per page, 1 to 100. Defaults to 50.

offset
string
default:0

Rows to skip, for pagination. Defaults to 0. offset + limit may not exceed 10000: narrow the window with fromDate and toDate to read further back. Later pages must pass the fromDate and toDate the first response echoed, or spend recorded in between shifts every page.

types
string[]

Credit types to keep, as the Credits page labels them: ledger types such as ENRICH_LEAD_EMAIL, VERIFY_EMAIL, SCRAPE_LEAD_LINKEDIN or TOPUP_PLAN (see GET /v1/credits/pricing for the spend actions), and the AI splits AI_MESSAGE, AI_ENRICHMENT, AI_VARIABLE_CAMPAIGN, AI_CHAT and AI_COMPLETION. Comma-separated or repeated; through MCP, an array.

Maximum array length: 60
Minimum string length: 1
Example:
userIds
integer[]

Only charges triggered by these Enginy user ids (the user.id of a line). Comma-separated or repeated; through MCP, an array.

Maximum array length: 200
Example:
costMin
integer | null

Lower bound on the absolute credit amount, inclusive.

Required range: x >= 0
Example:

10

costMax
integer | null

Upper bound on the absolute credit amount, inclusive.

Required range: x >= 0
Example:

5000

Response

Credit statement retrieved successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object
required