Get an invite
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/invites/{invite_id}Return one invite and its status.
For how this fits into a full workflow, see Invites.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
invite_id | string | The invite id, starting with invite_. |
Response
200 OK, Content-Type: application/json
{
"id": "invite_01JCD3F5H7K9M1P3R5T7",
"type": "invite",
"email": "sam@example.com",
"role": "developer",
"workspaces": [
{
"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
"role": "workspace_developer"
}
],
"status": "pending",
"invited_by": {
"id": "user_01J9X8Z6B4D2F0H8K6M4",
"email": "ops@example.com"
},
"created_at": "2026-11-05T10:00:00Z",
"expires_at": "2026-11-12T10:00:00Z",
"accepted_at": null
}| Field | Type | Description |
|---|---|---|
status | string | pending, accepted, expired or canceled. |
expires_at | string | Seven days after creation or the latest resend. |
Examples
curl -sS https://app.syntic.ai/v1/organizations/invites/invite_01JCD3F5H7K9M1P3R5T7 \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01"Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 404 | not_found_error | invite_not_found | No invite with that id. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?