> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/admin/llms.txt
> Use this file to discover all available pages before exploring further.

# List team invitations

Lists pending single-use email invitations for a team in the caller's organization.

The response contains pending invitations only. Accepted, cancelled, and expired
invitations are omitted. Items include team, email, role, and expiry. They never include
the invitation URL.

Paginate with `limit` and `continuation`. `continuation` is an opaque token. Presence of
`continuation` means more records exist. The last page omits `continuation`.

## HTTP method and URL path

GET https\://api.canva.com/admin/v1/teams/\{teamId}/invitations

### Rate limit

This operation is rate limited to 1000 requests per minute for your app.

## Authentication and authorization

This endpoint requires a valid access token that was generated using client credentials.

### Scopes

The access token must have all the following [scopes](/docs/admin/appendix/scopes) (permissions):

* `admin:team:read`

## Header parameters

<Prop.List>
  <Prop name="Authorization" type="string" required>
    Provides credentials to authenticate the request, in the form of a `Bearer` token.

    For example: `Authorization: Bearer {token}`
  </Prop>
</Prop.List>

## Path parameters

<Prop.List>
  <Prop name="teamId" type="string" required>
    The team ID.
  </Prop>
</Prop.List>

## Query parameters

<Prop.List>
  <Prop name="continuation" type="string">
    If the success response contains a continuation token, the list contains more items you can list. You can use this token as a query parameter and retrieve more items from the list, for example `?continuation={continuation}`.

    To retrieve all items, you might need to make multiple requests.
  </Prop>

  <Prop name="limit" type="integer">
    The maximum number of invitations to return.

    <Prop.Extras>
      **Minimum:** `1`

      **Maximum:** `100`

      **Default value:** `50`
    </Prop.Extras>
  </Prop>
</Prop.List>

## Example request

Examples for using the `/v1/teams/{teamId}/invitations` endpoint:

<Tabs storageKey="example.language" disableContentTransition>
  <Tab name="cURL">
    ```sh
    curl --request GET 'https://api.canva.com/admin/v1/teams/{teamId}/invitations' \
    --header 'Authorization: Bearer {token}'
    ```
  </Tab>

  <Tab name="Node.js">
    ```js
    const fetch = require("node-fetch");

    fetch("https://api.canva.com/admin/v1/teams/{teamId}/invitations", {
      method: "GET",
      headers: {
        "Authorization": "Bearer {token}",
      },
    })
      .then(async (response) => {
        const data = await response.json();
        console.log(data);
      })
      .catch(err => console.error(err));
    ```
  </Tab>

  <Tab name="Java">
    ```java
    import java.io.IOException;
    import java.net.URI;
    import java.net.http.*;

    public class ApiExample {
        public static void main(String[] args) throws IOException, InterruptedException {
            HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.canva.com/admin/v1/teams/{teamId}/invitations"))
                .header("Authorization", "Bearer {token}")
                .method("GET", HttpRequest.BodyPublishers.noBody())
                .build();

            HttpResponse<String> response = HttpClient.newHttpClient().send(
                request,
                HttpResponse.BodyHandlers.ofString()
            );
            System.out.println(response.body());
        }
    }
    ```
  </Tab>

  <Tab name="Python">
    ```py
    import requests

    headers = {
        "Authorization": "Bearer {token}"
    }

    response = requests.get("https://api.canva.com/admin/v1/teams/{teamId}/invitations",
        headers=headers
    )
    print(response.json())
    ```
  </Tab>

  <Tab name="C#">
    ```csharp
    using System.Net.Http;

    var client = new HttpClient();
    var request = new HttpRequestMessage
    {
      Method = HttpMethod.Get,
      RequestUri = new Uri("https://api.canva.com/admin/v1/teams/{teamId}/invitations"),
      Headers =
      {
        { "Authorization", "Bearer {token}" },
      },
    };

    using (var response = await client.SendAsync(request))
    {
      response.EnsureSuccessStatusCode();
      var body = await response.Content.ReadAsStringAsync();
      Console.WriteLine(body);
    };
    ```
  </Tab>

  <Tab name="Go">
    ```go
    package main

    import (
    	"fmt"
    	"io"
    	"net/http"
    )

    func main() {
    	url := "https://api.canva.com/admin/v1/teams/{teamId}/invitations"
    	req, _ := http.NewRequest("GET", url, nil)
    	req.Header.Add("Authorization", "Bearer {token}")

    	res, _ := http.DefaultClient.Do(req)
    	defer res.Body.Close()
    	body, _ := io.ReadAll(res.Body)
    	fmt.Println(string(body))
    }
    ```
  </Tab>

  <Tab name="PHP">
    ```php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.canva.com/admin/v1/teams/{teamId}/invitations",
      CURLOPT_CUSTOMREQUEST => "GET",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer {token}',
      ),
    ));

    $response = curl_exec($curl);
    $err = curl_error($curl);
    curl_close($curl);

    if (empty($err)) {
      echo $response;
    } else {
      echo "Error: " . $err;
    }
    ```
  </Tab>

  <Tab name="Ruby">
    ```ruby
    require 'net/http'
    require 'uri'

    url = URI('https://api.canva.com/admin/v1/teams/{teamId}/invitations')
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true

    request = Net::HTTP::Get.new(url)
    request['Authorization'] = 'Bearer {token}'

    response = http.request(request)
    puts response.read_body
    ```
  </Tab>
</Tabs>

## Success response

If successful, the endpoint returns a `200` response with a JSON body with the following parameters:

<Prop.List>
  <Prop name="items" type="TeamInvitation[]" required mode="output">
    A pending invitation for an email address to join a team. The invitation record exists only
    while the invitation can still be accepted.

    <PillAccordion title={<>Properties of <strong>items</strong></>} defaultExpanded={true}>
      <Prop.List>
        <Prop name="team_id" type="string" required mode="output">
          The ID of the team the invitation grants access to.
        </Prop>

        <Prop name="email" type="string" required mode="output">
          The invited email address. Only an account with this email can accept.
        </Prop>

        <Prop name="role" type="string" required mode="output">
          The role of the member in the team.

          <Prop.Extras>
            **Available values:**

            * `admin`
            * `designer`
            * `member`
          </Prop.Extras>
        </Prop>

        <Prop name="expires_at" type="integer" required mode="output">
          When the invitation expires, as a Unix timestamp (in seconds). This is always 30 days
          after the create or refresh request that issued it. Expired invitations can't be
          accepted.
        </Prop>

        <Prop name="url" type="string" mode="output">
          The invitation URL. Redirect the invitee to this URL to accept the invitation. Treat it
          as a secret: don't log it or send it over insecure channels. Create and a matched find
          result always return this field. Unfiltered list responses omit it.
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>

  <Prop name="continuation" type="string" mode="output">
    If the success response contains a continuation token, the list contains more items you can list. You can use this token as a query parameter and retrieve more items from the list, for example `?continuation={continuation}`.

    To retrieve all items, you might need to make multiple requests.
  </Prop>
</Prop.List>

## Example response

```json
{
  "items": [
    {
      "team_id": "BAAAAAAAAA1",
      "email": "drsmith@brightsmiledental.com",
      "role": "member",
      "expires_at": 1788499200,
      "url": "https://www.canva.com/brand/join?token=EXAMPLEQi1pbnZpdGU&referrer=team-invite"
    }
  ],
  "continuation": "RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN"
}
```

## Error responses

### 404 Not Found

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/admin/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error response

##### The team was not found

```json
{
  "code": "team_not_found",
  "message": "Team {teamId} not found"
}
```

### 429 Too many requests

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/admin/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error response

```json
{
  "code": "string",
  "message": "string"
}
```