List Invitations

1 curl https://api.coactive.ai/api/v1/auth-management/user-invitations \ 2 -H "Authorization: Bearer <token>"

1 { 2 "user_invitations": [ 3 { 4 "invitation_id": "inv_123", 5 "inviter": { 6 "name": "John Doe" 7 }, 8 "invitee": { 9 "email": "john@example.com", 10 "name": "John Doe", 11 "roles": [ 12 { 13 "role_id": "admin" 14 } 15 ] 16 }, 17 "invitation_url": "https://example.com/invitation/123", 18 "created_at": "2024-01-01T00:00:00Z", 19 "expires_at": "2024-01-01T00:00:00Z", 20 "roles": [ 21 { 22 "role_id": "admin" 23 } 24 ] 25 } 26 ], 27 "meta": { 28 "page": { 29 "current_page": 1, 30 "limit": 10, 31 "offset": 0, 32 "last_page": 10, 33 "total": 100 34 }, 35 "links": { 36 "prev": "prev", 37 "next": "/api/v1/auth-management/user-invitations?page=2&limit=10", 38 "first": "/api/v1/auth-management/user-invitations?page=1&limit=10", 39 "last": "/api/v1/auth-management/user-invitations?page=10&limit=10" 40 }, 41 "sort": [ 42 { 43 "direction": "asc", 44 "field": "created_at" 45 } 46 ] 47 } 48 }

List all pending user invitations. This endpoint retrieves a list of all pending invitations in the organization.

Query parameters

offsetintegerOptional>=0Defaults to 0

Number of records to skip (for pagination)

limitintegerOptional>=1<=100Defaults to 100

Number of invitations to return

Response

A paginated list of pending user invitations

user_invitationslist of objects

List of pending invitations

metaobject

Pagination metadata for the response

Headers

Query parameters

Response

Errors