Look up invite details by token
/v1/identity/auth/invite-infoRequest body
token *stringInvite token from the email link
Code samples
curl -X POST "https://api.canopy.dev/v1/identity/auth/invite-info" \
-H "Content-Type: application/json" \
-d '{
"token": "string"
}'const response = await fetch("https://api.canopy.dev/v1/identity/auth/invite-info", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"token": "string"
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.canopy.dev/v1/identity/auth/invite-info",
headers={
"Content-Type": "application/json"
},
json={
"token": "string",
},
)
data = response.json()package main
import (
"bytes"
"encoding/json"
"net/http"
)
func main() {
payload := map[string]interface{}{
"token": "string",
}
body, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.canopy.dev/v1/identity/auth/invite-info", bytes.NewBuffer(body))
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
}Responses
200 Invite details returned
{
"email": "string",
"intent": "activate",
"first_name": "string",
"last_name": "string",
"app_name": "string",
"inviter_email": "string"
}application/json
email *stringintent *enum: "activate" | "add_to_app" | "password_reset"What this invite does, and which form the SPA should render. `activate` creates a net-new identity — collect first name, last name, and a new password. `add_to_app` adds an existing identity to a new App — show 'sign in to confirm' UX and collect the user's existing password (verified server-side; not rotated). `password_reset` rotates the password on an existing identity — collect only the new password.
first_name *stringlast_name *stringapp_name *stringDisplay name of the App the recipient is being invited to. Used by the SPA to render welcome copy without a separate lookup.
inviter_email *stringEmail of the admin who issued the invite. Optional in the response — null when the inviter has been deleted.