---
title: "Get invites/requests"
method: GET
path: "/businesses/{business_id}/invites"
tags: ["business_access_invite"]
---

# Get invites/requests

`GET /businesses/{business_id}/invites`

## Request

- Base URL: `https://api.pinterest.com/v5`
- URL: `https://api.pinterest.com/v5/businesses/{business_id}/invites`
- Auth: OAuth 2
  - Authorization code: `https://www.pinterest.com/oauth/`
  - Token URL: `https://api.pinterest.com/v5/oauth/token` scopes: `biz_access:read`
- TypeScript: <https://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/businesses/:business_id/invites/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the membership/partnership invites and/or requests for the authorized user.

## Path parameters

- `business_id` string, required

## Query parameters

- `is_member` boolean
- `invite_status` InviteFilterStatus[]
- `invite_type` 'MEMBER_INVITE' | 'PARTNER_INVITE' | 'PARTNER_REQUEST': The type of invite. MEMBER_INVITE invites a member to access your business assets. PARTNER_INVITE invites a partner to access your business assets. PARTNER_REQUEST requests access to a partner's business assets.
- `bookmark` string
- `page_size` integer

## Response `200`

The request has succeeded.

- object
  - `bookmark` string, nullable
  - `items` InviteResponse[], required
    - `assets_summary` InviteAssetsSummary, nullable: Ad accounts and profiles the member/partner will be granted access to with this invite/request.
      - `ad_accounts` InviteAssetsSummaryItem[]: List of ad account IDs and respective permission levels that will be assigned.
        - `id` string: Unique identifier of the asset.
        - `permissions` string[]: Permission levels member or partner has on an asset.
      - `profiles` InviteAssetsSummaryItem[]: List of profile IDs and respective permission levels that will be assigned.
        - `id` string: Unique identifier of the asset.
        - `permissions` string[]: Permission levels member or partner has on an asset.
    - `business_roles` BusinessRoleResponse[]: The access level a user would be granted on the business if the invite/request is accepted. This can be EMPLOYEE, BIZ_ADMIN, or PARTNER.
    - `created_by_business` BusinessAccessUserSummary: Metadata of the member/partner that has access to the asset.
      - `email` string, nullable: Email of the business member/partner.
      - `id` string, nullable: Unique identifier of the business member/partner.
      - `username` string, nullable: Username of the business member/partner.
    - `created_by_user` BusinessAccessUserSummary: Metadata of the member/partner that has access to the asset.
      - `email` string, nullable: Email of the business member/partner.
      - `id` string, nullable: Unique identifier of the business member/partner.
      - `username` string, nullable: Username of the business member/partner.
    - `created_time` integer: The time the invite/request was created. Returned in milliseconds.
    - `id` string: Unique identifier of the invite/request.
    - `invite_data` InviteDataResponse: Metadata for the invite/request.
      - `invite_expiration` integer: The date and time when the invite/request will expire. Returned in milliseconds.
      - `invite_status` string: The current status of the invite. The invite can be in one of the following states PENDING, ACCEPTED, DECLINED, CANCELLED, EXPIRED.
      - `invite_type` string: The type of invite. - 'MEMBER_INVITE' is to invite a member to access your business assets. - 'PARTNER_INVITE' is to invite a partner to access your business assets. - 'PARTNER_REQUEST' is to request access a partner's business assets.
      - `last_updated_time` integer: The date and time the invite/request was last updated. Returned in milliseconds.
      - `sent_at` integer: The date and time the invite/request was sent/created. Returned in milliseconds.
    - `is_received_invite` boolean: Indicates whether the invite/request was received.
    - `user` BusinessAccessUserSummary: Metadata of the member/partner that has access to the asset.
      - `email` string, nullable: Email of the business member/partner.
      - `id` string, nullable: Unique identifier of the business member/partner.
      - `username` string, nullable: Username of the business member/partner.

## Other responses

- `400`: The request could not be understood by the server due to unexpected data.
- `401`: Authentication is required and has either failed or not been provided.
- `403`: The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404`: The requested resource could not be found on this server.
- `429`: The user has sent too many requests in a given amount of time and is being rate limited.
- `default`: An unexpected error response.

## Changes

- **2026-06-04** (v5) `b698c180678a`: 1 breaking, 8 info
  - the response's body type changed from no type to `object` for status `200`
  - removed `#/components/schemas/Paginated, subschema #2` from the response body `allOf` list for the response status `200`
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - …5 more
- **2024-04-23** (v5) `f9321315766f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/businesses/:business_id/invites/get.md)

---

[API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) - [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pinterest/apis/pinterest-rest-api/revisions/b698c180678a?raw)