> ## 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.

# Find team invitation

Finds a pending single-use email invitation for a team in the caller's organization.

The email address is restricted data and is accepted only in the JSON request body. The
response contains zero or one invitation. A matching invitation includes the invitation URL
so the caller can deliver it without refreshing the invitation.

Treat the returned `url` as a secret. Don't log the URL or send it over insecure channels.

## HTTP method and URL path

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

### 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 name="Content-Type" type="string" required>
    Indicates the media type of the information sent in the request. This must be set to `application/json`.

    For example: `Content-Type: application/json`
  </Prop>
</Prop.List>

## Path parameters

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

## Body parameters

<Prop.List>
  <Prop name="email" type="string" required>
    The email address associated with the invitation.

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

      **Maximum length:** `254`
    </Prop.Extras>
  </Prop>
</Prop.List>

## Example request

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

<Tabs storageKey="example.language" disableContentTransition>
  <Tab name="cURL">
    ```sh
    curl --request POST 'https://api.canva.com/admin/v1/teams/{teamId}/invitations/find' \
    --header 'Authorization: Bearer {token}' \
    --header 'Content-Type: application/json' \
    --data '{
      "email": "drsmith@brightsmiledental.com"
    }'
    ```
  </Tab>

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

    fetch("https://api.canva.com/admin/v1/teams/{teamId}/invitations/find", {
      method: "POST",
      headers: {
        "Authorization": "Bearer {token}",
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        "email": "drsmith@brightsmiledental.com"
      }),
    })
      .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/find"))
                .header("Authorization", "Bearer {token}")
                .header("Content-Type", "application/json")
                .method("POST", HttpRequest.BodyPublishers.ofString("{\"email\": \"drsmith@brightsmiledental.com\"}"))
                .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}",
        "Content-Type": "application/json"
    }

    data = {
        "email": "drsmith@brightsmiledental.com"
    }

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

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

    var client = new HttpClient();
    var request = new HttpRequestMessage
    {
      Method = HttpMethod.Post,
      RequestUri = new Uri("https://api.canva.com/admin/v1/teams/{teamId}/invitations/find"),
      Headers =
      {
        { "Authorization", "Bearer {token}" },
      },
      Content = new StringContent(
        "{\"email\": \"drsmith@brightsmiledental.com\"}",
        Encoding.UTF8,
        "application/json"
      ),
    };

    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"
    	"strings"
    )

    func main() {
    	payload := strings.NewReader(`{
    	  "email": "drsmith@brightsmiledental.com"
    	}`)

    	url := "https://api.canva.com/admin/v1/teams/{teamId}/invitations/find"
    	req, _ := http.NewRequest("POST", url, payload)
    	req.Header.Add("Authorization", "Bearer {token}")
    	req.Header.Add("Content-Type", "application/json")

    	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/find",
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer {token}',
        'Content-Type: application/json',
      ),
      CURLOPT_POSTFIELDS => json_encode([
        "email" => "drsmith@brightsmiledental.com"
      ])
    ));

    $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/find')
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true

    request = Net::HTTP::Post.new(url)
    request['Authorization'] = 'Bearer {token}'
    request['Content-Type'] = 'application/json'
    request.body = <<REQUEST_BODY
    {
      "email": "drsmith@brightsmiledental.com"
    }
    REQUEST_BODY

    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="invitation" type="TeamInvitation" 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>invitation</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.List>

## Example responses

### A pending invitation matches the email

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

### No pending invitation matches the email

```json
{}
```

## Error responses

### 400 Bad Request

<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 email address is not valid

```json
{
  "code": "invalid_field",
  "message": "'email' must be a valid email address."
}
```

### 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"
}
```