Vigilfield Docs
API referenceInvitations

Invitation_lookup_by_token

POST/invitation-tokens/{invitation}/lookups

Path Parameters

invitation*string

Invitation locator <org_id>.<invite_id>. NOT a credential — the secret rides the body.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Body of POST /invitation-tokens/{invitation}/lookups.

The whole body is the credential: the path carries only the locator, and the secret rides here because a request body is the one place on this path that nothing records(see token.rs's module header). The field name is load-bearing too: audit_redact's denylist masks any key containing secret, so the audit event records [REDACTED] rather than the value.

Response Body

application/json

curl -X POST "https://example.com/invitation-tokens/string/lookups" \  -H "Content-Type: application/json" \  -d '{    "secret": "string"  }'
{  "email": "string",  "expires_at": "string",  "org_id": "string",  "role": "owner",  "status": "pending"}