Skip to main content
GET
Get a firm

Authorizations

Authorization
string
header
required

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

Path Parameters

firmId
string<uuid>
required

Slate's UUID for the firm (returned by create). The canonical firm identifier.

Response

The firm.

A service firm managed by an owner. Placements reference it by firmId.

firmId
string<uuid>
required
read-only

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

owner
string
required

The organization that manages this firm.

firmCode
string
required
read-only

The firm's oliver firm code, generated by Slate on create.

name
string
required

Human-readable firm name.

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: