Skip to main content

Get account

GET/v20/account

Returns the account matching the authenticated API credential. The account ID is derived from the authorization context — no path parameter is needed.

Authentication​

Requires HTTP Basic authentication with your API Credential ID and Token.

Content Type​

application/vnd.api+json

Response​

200 — Account details (JSON:API)​

{
"data": {
"type": "accounts",
"id": "c75c40ff-3263-4171-afe4-1e138f8ea616",
"attributes": {
"name": "Paisano's Pizza",
"ownerName": "John Paisano",
"ownerEmail": "john@paisanos.com",
"billingEmail": "billing@paisanos.com",
"logoEnabled": true,
"enabled": true,
"defaultJobTemplateId": "a1b2c3d4-5678-4abc-9def-012345678901",
"printerCount": 3,
"createdAt": "2025-06-01T00:00:00Z",
"updatedAt": "2026-03-22T12:00:00Z"
}
}
}

Attributes​

FieldTypeDescription
namestringAccount name
ownerNamestringAccount owner name
ownerEmailstring (email)Account owner email
billingEmailstring (email)Billing contact email
logoEnabledbooleanWhether the account logo is enabled for printing
enabledbooleanWhether the account is active
defaultJobTemplateIdstring (UUID) | nullDefault job template for new printers
printerCountintegerNumber of printers on the account
createdAtstring (date-time)Account creation timestamp
updatedAtstring (date-time)Last update timestamp

403 — Account not found or disabled​

{
"errors": [
{ "status": "403", "title": "Forbidden", "detail": "Account not found" }
]
}
{
"errors": [
{ "status": "403", "title": "Forbidden", "detail": "Account is disabled. Contact support to re-enable your account." }
]
}

401 — Not authorized​

Returned when the API credential is invalid, disabled, or missing.