> ## Documentation Index > Fetch the complete documentation index at: https://docs.slate.inc/llms.txt > Use this file to discover all available pages before exploring further. # Get a entity > Returns a entity on the account by its `entityId`. ## OpenAPI ````yaml /api-reference/accounts/openapi.yaml get /v1/accounts/{accountId}/entities/{entityId} openapi: 3.0.0 info: title: Accounts API (DRAFT) version: 0.0.1 contact: name: Slate API Support email: api-support@slate.inc url: https://slate.inc description: >- **DRAFT. Shapes, names, and field sets may change before this is finalized** The Accounts API is how an owner keeps Slate's view of its accounts in sync. An **account** is the primary data entity that Slate services against, mapping to the originating account that the debt is associated with. **Two identifiers.** Slate assigns each account a stable UUID, `accountId` — this is the canonical id and the key for every read and targeted update. You also carry your own identifier for the account, `crid` (the account number in your system), which is unique within your organization (`owner`). You do not know Slate's `accountId` until the account has been created, so the first write is an **upsert** keyed on your `crid`; the response returns the assigned `accountId`, which you use from then on (and can re-resolve any time via `GET /v1/accounts?crid=...`). **Upsert.** `POST /v1/accounts` idempotently creates the account if new or updates it if one already exists for your `(owner, crid)`. Send the account's current state as a full snapshot — this is how a daily inventory feed keeps Slate in sync. Targeted updates use a partial `PATCH /v1/accounts/{accountId}` — send only the fields that changed (balance, status, placement, legal, …) — for owners that prefer not to resend the whole account. **Scoping & auth.** Every request is scoped to a single `owner`; `crid` is unique only within an owner. List requests take a required `owner` query parameter (which your token must be authorized to read); writes are scoped to the single `owner` on your bearer token. **Money.** All monetary amounts are **US dollars with two decimal places**, sent and returned as decimal **strings** (e.g. `"1250.75"`) to avoid floating-point rounding. Do not send minor units (cents) or bare JSON numbers. servers: - url: https://api.slate.inc/accounts description: Production - url: https://api.uat.slate.inc/accounts description: UAT (staging) security: - bearerAuth: [] paths: /v1/accounts/{accountId}/entities/{entityId}: parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/EntityId' get: summary: Get a entity description: Returns a entity on the account by its `entityId`. operationId: getEntity responses: '200': description: The entity. content: application/json: schema: $ref: '#/components/schemas/Entity' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' components: parameters: AccountId: name: accountId in: path required: true description: >- Slate's UUID for the account (returned by the upsert). The canonical account identifier. schema: type: string format: uuid EntityId: name: entityId in: path required: true description: Slate's UUID for the entity (customer). The canonical entity identifier. schema: type: string format: uuid schemas: Entity: type: object description: A entity (customer) on an account, with their addresses. required: - entityId - matterId - type properties: entityId: type: string format: uuid readOnly: true description: Slate's stable UUID for the entity. matterId: type: string format: uuid readOnly: true description: The matter this entity belongs to. type: $ref: '#/components/schemas/EntityType' name: type: string description: >- The entity's name — for a person, natural "FIRST MIDDLE LAST SUFFIX" form; for an organization, its name. Slate derives internal first/middle/last/suffix name fields from this. dateOfBirth: type: string format: date phone: type: string email: type: string alsoKnown: type: string externalEntityId: type: string description: The entity's identifier in your system. languagePreference: type: string ssnLastFour: type: string readOnly: true description: >- The last four digits of the entity's SSN/EIN. The full value is never returned. officialAddress: allOf: - $ref: '#/components/schemas/Address' description: >- Where communications to the entity are sent — the address of record for correspondence. mailingAddress: $ref: '#/components/schemas/Address' physicalAddress: allOf: - $ref: '#/components/schemas/Address' description: >- The entity's physical location — used to determine firm placement and which templates to use. When not provided, processes fall back to the official address in its place. metadata: $ref: '#/components/schemas/Metadata' EntityType: type: string description: The entity's role on the account. enum: - AUTHORIZED_USER - BORROWER - DEBT_SETTLEMENT_COMPANY - NON_BORROWING_DEFENDANT Address: type: object description: A postal address. properties: addressLine1: type: string addressLine2: type: string city: type: string stateProvCode: type: string postalCode: type: string country: type: string Metadata: type: object description: >- 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. additionalProperties: type: string example: region: west portfolio_tier: gold Error: type: object required: - message properties: message: type: string description: A human-readable description of what went wrong. responses: Unauthorized: description: Missing, invalid, or insufficiently scoped credentials. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: The requested resource does not exist or is not visible to your owner. content: application/json: schema: $ref: '#/components/schemas/Error' ServerError: description: Unexpected internal error. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Owner-scoped bearer token. The `owner` all requests are scoped to is derived from the token. ````