---
title: "ListTenants"
method: GET
path: "/v1/tenants"
tags: ["TenantService"]
---

# ListTenants

`GET /v1/tenants`

Lists all tenants.

## Query parameters

- `filter` string
- `page_token` integer
- `page_size` integer
- `action` string
- `mask` string
- `traverse` boolean
- `sort.path` string
- `sort.order` 'SORT_ENTRY_ORDER_UNSPECIFIED' | 'SORT_ENTRY_ORDER_ASC' | 'SORT_ENTRY_ORDER_DESC'
- `count` boolean
- `group.aggregation_paths` string
- `group.show_aggregation_uuids` boolean
- `group.unique_count_paths` string
- `group.unique_value_paths` string
- `ci_run_uuid` string
- `page_id` string
- `group_by_time.aggregation_paths` string
- `group_by_time.show_aggregation_uuids` boolean
- `group_by_time.interval` 'GROUP_BY_TIME_INTERVAL_UNSPECIFIED' | 'GROUP_BY_TIME_INTERVAL_YEAR' | 'GROUP_BY_TIME_INTERVAL_QUARTER' | 'GROUP_BY_TIME_INTERVAL_MONTH' | 'GROUP_BY_TIME_INTERVAL_WEEK' | 'GROUP_BY_TIME_INTERVAL_DAY' | 'GROUP_BY_TIME_INTERVAL_HOUR' | 'GROUP_BY_TIME_INTERVAL_MINUTE' | 'GROUP_BY_TIME_INTERVAL_SECOND'
- `group_by_time.group_size` integer
- `group_by_time.start_time` string, date-time
- `group_by_time.end_time` string, date-time
- `group_by_time.mode` string
- `group_by_time.aggregation_value_field` string
- `group_by_time.aggregation_operator` string
- `disable_pagination` boolean

## Response `200`

A successful response.

- V1ListTenantsResponse — Response to the request to list tenants.
  - `count_response` V1CountResponse — Response to a list count request.
    - `count` integer — Number of objects matching the given list parameters.
  - `group_response` V1GroupResponse — Response to a list group request.
    - `groups` object — Map indexed by values of the fields specified in aggregation_paths, for example, {"[{"key":"meta.kind","value":"Project"}]": { "aggregation_count": { "count": 1649 } } }.
  - `list` V1ListTenantsResponseList
    - `objects` V1Tenant[]
      - `meta` V1Meta, required — Common fields for all Endor Labs resources.
        - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller.
        - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
        - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
        - `description` string — Resource description. Must be less than 1024 bytes.
        - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object.
          - `data` string[]
          - `search_score` number, float — search_score is the score of the resource for search. Internal use only.
          - `tenant` string
          - `will_be_deleted_at` string, date-time — Time that the resource will be deleted.
        - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
        - `name` string, required — Resource name. Must be 63 characters or less.
        - `parent_kind` string — Parent object resource kind, for example, Project.
        - `parent_uuid` string — Parent object UUID.
        - `references` object — Map of objects referenced in a query API.
        - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less.
        - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
        - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
        - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
        - `version` string — Message version.
      - `spec` V1TenantSpec
        - `city` string — The city of a users address.
        - `code` string — A user's area code.
        - `country` string — A user's country of residence.
        - `organization_urls` string[] — The list of URLs which are associated with the given organization which can be included in the supplier SBOM information.
        - `organizational_contacts` V1TenantSpecOrganizationalContact[] — The list of contact that we can put as the contact in the SBOM export supplier information.
          - `email` string
          - `name` string, required
          - `phone` string
        - `organizational_entity_name` string
        - `phone_number` string — A user's phone number.
        - `placement_zone` string — The placement zone for internal tenant routing and sharding.
        - `state` string — The state of a users address.
        - `street` string — The street address of a user.
      - `uuid` string — The UUID of a tenant.
    - `response` V1ListResponse — Response to a list request.
      - `next_page_id` string — The UUID of last message retrieved.
      - `next_page_token` integer — Pagination token that can be used to retrieve the next page of results.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference.md) · [All operations](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/endorlabs/endor-labs-rest-api-reference/versions/2fe1f84213b3/schema)