---
title: "List all entities"
method: GET
path: "/entities"
tags: ["Entities"]
---

# List all entities

`GET /entities`

Returns a paginated list of all entities in the current user's firm. Results are paginated using `page` and `per_page` parameters. Use `extended_view=true` to include full contact, project, and tag details.

## Query parameters

- `page` integer
- `per_page` integer
- `extended_view` 'true' | 'false'

## Response `200`

successful

- object
  - `data` union[] — When extended_view is not set, returns normal entity objects. When extended_view=true, returns EntityExtended objects.
    - union
      - Entity
        - `id` integer
        - `client_id_number` string
        - `name` string
        - `entity_type` string
        - `metadata` object
        - `ein` string
        - `other_ids` object
        - `created_at` string, date-time
        - `updated_at` string, date-time
        - `primary_contact` Contact
          - `contact` object
            - `first_name` string
            - `last_name` string
            - `tag_list` string[]
            - `created_at` string, date-time
            - `updated_at` string, date-time
            - `contact_emails_attributes` object[]
              - …
            - `contact_phones_attributes` object[]
              - …
        - `contacts` Contact[]
          - `contact` object
            - `first_name` string
            - `last_name` string
            - `tag_list` string[]
            - `created_at` string, date-time
            - `updated_at` string, date-time
            - `contact_emails_attributes` object[]
              - …
            - `contact_phones_attributes` object[]
              - …
        - `projects` Project[]
          - `id` integer
          - `name` string
          - `idempotency_key` string
          - `metadata` object
          - `due_date` string, date-time
          - `assignees` Assignee[]
            - `id` integer
            - `email` string
          - `user` User
            - `id` integer
            - `email` string
          - `tags` Tag[]
            - `id` integer
            - `name` string
          - `tasks` Task[]
            - `id` integer
            - `name` string — Name of the task
            - `description` string — Description of the task - supports limited subset of HTML <b>, <ul>, <li>, <br>, and <a>.
            - `status` 'to_do' | 'pending_review' | 'approved' — Status of the task
          - `project_status` ProjectStatus
            - `id` integer
            - `name` string
            - `position` integer
      - EntityExtended
        - `id` integer
        - `client_id_number` string
        - `name` string
        - `entity_type` string
        - `metadata` object — Additional metadata for the entity, contents may vary
        - `ein` string — Employer Identification Number (EIN)
        - `other_ids` object — Other identifying information, contents may vary
        - `created_at` string, date-time
        - `updated_at` string, date-time
        - `primary_contact` object — Primary contact for this entity
        - `contacts` ContactExtended[] — List of contacts associated with this entity
          - `id` integer
          - `first_name` string
          - `last_name` string
          - `nick_name` string
          - `company` string
          - `job_title` string
          - `client_id_number` string
          - `tags` Tag[]
            - `id` integer
            - `name` string
          - `contact_emails` ContactEmail[]
            - `id` integer
            - `email` string
            - `primary` boolean
            - `created_at` string, date-time
            - `updated_at` string, date-time
          - `contact_phones` ContactPhone[]
            - `id` integer
            - `phone_number` string
            - `country_code` string
            - `country_phone_code` string
            - `phone_type` 'mobile' | 'home' | 'work' | 'fax' | 'office' | 'other'
            - `primary` boolean
            - `metadata` object
            - `created_at` string, date-time
            - `updated_at` string, date-time
          - `contact_addresses` ContactAddress[]
            - `id` integer
            - `street_address` string
            - `city` string
            - `state` string
            - `zip` string
            - `primary` boolean
            - `created_at` string, date-time
            - `updated_at` string, date-time
          - `entity_origins` Entity[]
            - `id` integer
            - `client_id_number` string
            - `name` string
            - `entity_type` string
            - `metadata` object
            - `ein` string
            - `other_ids` object
            - `created_at` string, date-time
            - `updated_at` string, date-time
            - `primary_contact` Contact
              - …
            - `contacts` Contact[]
              - …
            - `projects` Project[]
              - …
        - `projects` ProjectExtended[] — List of projects associated with this entity
          - `id` integer
          - `name` string
          - `tax_year` string
          - `idempotency_key` string
          - `metadata` object
          - `due_date` string, date-time
          - `assignees` Assignee[]
            - `id` integer
            - `email` string
          - `tasks` Task[]
            - `id` integer
            - `name` string — Name of the task
            - `description` string — Description of the task - supports limited subset of HTML <b>, <ul>, <li>, <br>, and <a>.
            - `status` 'to_do' | 'pending_review' | 'approved' — Status of the task
          - `user` User
            - `id` integer
            - `email` string
          - `tags` Tag[]
            - `id` integer
            - `name` string
          - `entity` Entity
            - `id` integer
            - `client_id_number` string
            - `name` string
            - `entity_type` string
            - `metadata` object
            - `ein` string
            - `other_ids` object
            - `created_at` string, date-time
            - `updated_at` string, date-time
            - `primary_contact` Contact
              - …
            - `contacts` Contact[]
              - …
            - `projects` Project[]
              - …
  - `pagy` PagyMetadata — Pagination metadata (Pagy)
    - `count` integer — Total number of items
    - `page` integer — Current page number
    - `items` integer — Number of items per page
    - `pages` integer — Total number of pages
    - `prev` integer, nullable — Previous page number (null if none)
    - `next` integer, nullable — Next page number (null if none)

## Other responses

- `400` — Page number is out of range

---

[API](https://skmtc.net/gettruss/apis/api-v1.md) · [All operations](https://skmtc.net/gettruss/apis/api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gettruss/api-v1/versions/9418bb2b65bf/schema)