--- 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[] — Every element has the same shape, determined by the extended_view parameter. By default each element is an Entity (scalar attributes only — no contacts, projects, or tags). With extended_view=true each element is an EntityExtended, the same representation GET /entities/{id} returns, including contacts with effective_email. - union - Entity — Summary representation of an entity. Contains scalar attributes only — no contacts, projects, or tags. Use GET /entities/{id}, or GET /entities?extended_view=true, for the EntityExtended representation that includes those associations. - `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 - EntityExtended — Full representation of an entity, including tags, contacts, and projects. Returned by GET /entities/{id}, GET /entities?extended_view=true, and the link_contact / link_project endpoints. - `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 - `tags` Tag[] — Tags applied to this entity - `id` integer - `name` string - `primary_contact` EntityContactExtended - `id` integer - `first_name` string - `last_name` string - `nick_name` string - `company` string - `job_title` string - `client_id_number` string - `created_at` string, date-time - `updated_at` string, date-time - `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 — 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 - `effective_email` EffectiveEmail, nullable — The email to use for this contact in the containing entity or project context. Falls back to the contact's global primary email. - `id` integer - `email` string, email - `overridden` boolean — Whether an entity-level override selected this email. - `source` 'manual' | 'cch_axcess' | 'null', nullable — Source of the entity-level override, or null when using the global primary email. - `contacts` EntityContactExtended[] — 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 - `created_at` string, date-time - `updated_at` string, date-time - `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 — 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 - `effective_email` EffectiveEmail, nullable — The email to use for this contact in the containing entity or project context. Falls back to the contact's global primary email. - `id` integer - `email` string, email - `overridden` boolean — Whether an entity-level override selected this email. - `source` 'manual' | 'cch_axcess' | 'null', nullable — Source of the entity-level override, or null when using the global primary email. - `projects` ProjectExtended[] — List of projects associated with this entity - `id` integer - `name` string - `tax_year` integer, nullable — Four-digit year parsed from the project name, or null if the name contains no recent year. - `idempotency_key` string - `metadata` object - `due_date` string, date-time - `reminder_schedule_name` string, nullable — Name of the project's reminder schedule, or null if none is set. - `assignees` AssigneeWithContact[] - `id` integer - `display_name` string - `name` string - `email` string, nullable — Contact's global primary email, or null if the contact has none. - `magic_link` string — Assignee's magic upload URL. - `contact` EntityContactSummary — Summary representation of a contact. Scalar attributes only — no emails, phones, addresses, tags, or linked entities. Use GET /contacts/{contact_id} for the ContactExtended representation that includes those. - … - `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 - `first_name` string - `last_name` string - `idempotency_key` string, nullable - `tags` Tag[] - `id` integer - `name` string - `entity` Entity — Summary representation of an entity. Contains scalar attributes only — no contacts, projects, or tags. Use GET /entities/{id}, or GET /entities?extended_view=true, for the EntityExtended representation that includes those associations. - `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 - `project_status` ProjectStatus - `id` integer - `name` string - `position` integer - `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/7c956b3d1bdf/schema)