List invites
/api/v1/identity-invitesAuthentication
- Bearer Token
AuthorizationJWT access token
- API Key
X-API-KeyAPI key for management-tier access
Query Parameters
| Name | Required | Type | Description |
|---|---|---|---|
page | number | Page number (1-based) | |
take | number | Items per page (1-100, default 20) | |
q | string | Search term | |
sort_by | string | Column to sort by. Allowed values depend on the endpoint. | |
order | enum: "asc" | "desc" | Sort direction | |
status | enum: "pending" | "accepted" | "revoked" | "expired" | Filter by invite status |
Code samples
curl -X GET "https://api.canopy.dev/api/v1/identity-invites?page=0&take=0&q=value&sort_by=value&order=asc&status=pending" \ -H "X-API-Key: $CANOPY_API_KEY"
const response = await fetch("https://api.canopy.dev/api/v1/identity-invites?page=0&take=0&q=value&sort_by=value&order=asc&status=pending", {
method: "GET",
headers: {
"X-API-Key": "$CANOPY_API_KEY"
},
});
const data = await response.json();import requests
response = requests.get(
"https://api.canopy.dev/api/v1/identity-invites?page=0&take=0&q=value&sort_by=value&order=asc&status=pending",
headers={
"X-API-Key": "$CANOPY_API_KEY"
},
)
data = response.json()package main
import (
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.canopy.dev/api/v1/identity-invites?page=0&take=0&q=value&sort_by=value&order=asc&status=pending", nil)
req.Header.Set("X-API-Key", "$CANOPY_API_KEY")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
}Responses
200 Paginated list
{
"items": [
{
"id": "string",
"email": "string",
"intent": "activate",
"first_name": "string",
"last_name": "string",
"name": "string",
"role_id": "string",
"node_id": "string",
"has_initial_assignment": false,
"status": "pending",
"expires_at": "2026-04-20T12:00:00.000Z",
"invited_by": "string",
"created_at": "2026-04-20T12:00:00.000Z"
}
],
"pagination": {
"page": 0,
"take": 0,
"item_count": 0,
"page_count": 0,
"has_previous_page": false,
"has_next_page": false
}
}application/json
itemsIdentityInviteResponseDto[]paginationPageMetaDto
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)
Pagination
This endpoint returns a paginated collection. Use the query parameters below to page through results.
page- Page number (1-indexed). Defaults to 1.
take- Items per page (1–100). Defaults to 20.
Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.