---
title: "List an enterprise's guests."
method: GET
path: "/enterprises/{enterpriseId}/guests"
tags: ["enterprises"]
---

# List an enterprise's guests.

`GET /enterprises/{enterpriseId}/guests`

## Request

- Base URL: `https://api.shorebird.dev/api/v1`
- URL: `https://api.shorebird.dev/api/v1/enterprises/{enterpriseId}/guests`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

By email: the people who reach its organizations' apps but are not
its members, each flagged when its guest policy would refuse them
now. Carries what they reach as the member list does, and
`outside_guest_policy_count` over every guest. Admins only.

## Query parameters

- `per_page` integer
- `cursor` string
- `page` integer
- `sort` 'person' | '-person' | 'last_sign_in' | '-last_sign_in' | 'last_active' | '-last_active'

## Response `200`

One page of guests.

- object: The paging fields of a page of an enterprise list.
  - `total_count` integer, required: How many items the whole list holds.
  - `next_cursor` string: The cursor of the next page; absent on the last page.
  - `teams` EnterpriseTeam[], required
    - `id` integer, required
    - `name` string, required
    - `member_count` integer, required
    - `app_count` integer, required
    - `default_role` 'viewer' | 'developer', required: A role a default organization joins people at.
    - `apps` EnterpriseAppSummary[], required
      - `id` string, required
      - `display_name` string, required
  - `apps` EnterpriseAppSummary[], required
    - `id` string, required
    - `display_name` string, required
  - `guests` EnterpriseGuest[], required
    - `user_id` integer, required
    - `email` string, nullable, required
    - `display_name` string, nullable, required
    - `kind` string, required: What kind of account it is.
    - `teams` EnterpriseTeamAccess[], required
      - `team_id` integer, required
      - `role` 'owner' | 'admin' | 'appManager' | 'developer' | 'viewer' | 'auditor' | 'scim' | 'none', required: A role that a user can have relative to an Organization or App.
    - `app_grants` EnterpriseAppGrant[], required
      - `app_id` string, required
      - `role` 'owner' | 'admin' | 'appManager' | 'developer' | 'viewer' | 'auditor' | 'scim' | 'none', required: A role that a user can have relative to an Organization or App.
    - `sign_in_method` 'google' | 'microsoft' | 'saml' | 'other', required: How a person signs in, named from their identity's issuer.
    - `signed_in_at` string, date-time, nullable, required
    - `last_active_at` string, date-time, nullable, required
    - `outside_guest_policy` boolean, required: Whether the guest policy would refuse them now.
  - `outside_guest_policy_count` integer, required: How many guests the policy would refuse now.

## Other responses

- `default`: Standard error response. Emitted for any non-2xx status where a body can be decoded into an [ErrorResponse].

---

[API](https://skmtc.dev/shorebird/apis/shorebird-codepush-api.md) - [All operations](https://skmtc.dev/shorebird/apis/shorebird-codepush-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shorebird/apis/shorebird-codepush-api/revisions/941da8871d10?raw)