Skip to main content
GET
Get an account

Authorizations

Authorization
string
header
required

Owner-scoped bearer token. The owner all requests are scoped to is derived from the token.

Path Parameters

accountId
string<uuid>
required

Slate's UUID for the account (returned by the upsert). The canonical account identifier.

Response

The account.

The full account aggregate as Slate holds it.

accountId
string<uuid>
required
read-only

Slate's stable UUID for the account — the canonical identifier, assigned by Slate on create.

owner
string
required

The organization that owns this account in Slate (your owner code).

crid
string
required

Your identifier for the account (the account number in your system) — the natural key the upsert matches on, unique within your owner.

creditorId
string<uuid>
required

The creditor this account belongs to (Slate creditor UUID). Register creditors via POST /v1/creditors; must be one your owner manages.

status
enum<string>
required

Account lifecycle status. Binary: ACTIVE (being serviced) or CLOSED (resolved, returned, or otherwise done).

Available options:
ACTIVE,
CLOSED
currentBalance
string<decimal>
required

The current amount owed, in US dollars, as a decimal string (e.g. "1250.75").

Pattern: ^-?\d+(\.\d{1,2})?$
matterId
string<uuid>
read-only

Current active matter UUID for the account. Currently created on initial account creation, but support will be added later for managing an accounts matters, both current and historical.

accountNumber
string

The current client/account number. May change over the life of the account (e.g. when paper is sold).

accountNumberHistory
object[]
read-only

The history of account-number changes for this account, oldest first. Empty when the number has never changed. Read-only — recorded automatically whenever accountNumber changes.

portfolioId
string | null

Portfolio identifier, when the account is part of a purchased portfolio. Absent for forwarded/placed paper.

closedOn
string<date> | null

The date the account was closed; null while ACTIVE.

chargeOffDate
string<date> | null

The date the account was charged off, if applicable.

placement
object | null

The servicing firm the account is currently placed with, and its fee terms. Null when the account is not placed.

The account's legal activity. A suit and/or a judgment; either may be absent.

createdOn
string<date-time>
read-only

When Slate first created the account.

lastUpdated
string<date-time>
read-only

When the account was last updated in Slate.

metadata
object

Custom key/value pairs you can attach to an object for reporting, analytics, or attributes Slate does not model natively — inspired by Stripe metadata. Values are strings. Limits: at most 50 keys, each key at most 40 characters and each value at most 500 characters. On a partial update (PATCH) the keys you send are merged into the existing metadata; send a key with an empty-string value to remove it. An account upsert (full snapshot) replaces the whole map.

Example: