---
title: "Get all invitations for a shared dashboard"
method: GET
path: "/api/v1/dashboard/public/{token}/invitation"
tags: ["Dashboards"]
---

# Get all invitations for a shared dashboard

`GET /api/v1/dashboard/public/{token}/invitation`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `dashboards_invite_share`

Describe the invitations that exist for the given shared dashboard (paginated).

## Path parameters

- `token` string, required

## Query parameters

- `page_size` integer
- `page_number` integer

## Response `200`

OK

- SharedDashboardInvites: Invitations data and metadata that exists for a shared dashboard returned by the API.
  - `data` union, required: An object or list of objects containing the information for an invitation to a shared dashboard.
    - SharedDashboardInvitesDataObject: Object containing the information for an invitation to a shared dashboard.
      - `attributes` SharedDashboardInvitesDataObjectAttributes, required: Attributes of the shared dashboard invitation
        - `created_at` string, date-time: When the invitation was sent.
        - `email` string: An email address that an invitation has been (or if used in invitation request, will be) sent to.
        - `has_session` boolean: Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
        - `invitation_expiry` string, date-time: When the invitation expires.
        - `session_expiry` string, date-time, nullable: When the invited user's session expires. null if the invitation has no associated session.
        - `share_token` string: The unique token of the shared dashboard that was (or is to be) shared.
      - `type` 'public_dashboard_invitation', required: Type for shared dashboard invitation request body.
    - SharedDashboardInvitesDataObject[]: A list of objects containing the information for an invitation(s) to a shared dashboard.
      - `attributes` SharedDashboardInvitesDataObjectAttributes, required: Attributes of the shared dashboard invitation
        - `created_at` string, date-time: When the invitation was sent.
        - `email` string: An email address that an invitation has been (or if used in invitation request, will be) sent to.
        - `has_session` boolean: Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
        - `invitation_expiry` string, date-time: When the invitation expires.
        - `session_expiry` string, date-time, nullable: When the invited user's session expires. null if the invitation has no associated session.
        - `share_token` string: The unique token of the shared dashboard that was (or is to be) shared.
      - `type` 'public_dashboard_invitation', required: Type for shared dashboard invitation request body.
  - `meta` SharedDashboardInvitesMeta: Pagination metadata returned by the API.
    - `page` SharedDashboardInvitesMetaPage: Object containing the total count of invitations across all pages
      - `total_count` integer: The total number of invitations on this shared board, across all pages.

## Other responses

- `403`: Forbidden
- `404`: Not Found
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v1-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v1-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v1-collection/revisions/ca5871004d26?raw)