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

HeaderRequiredValue
AuthorizationYesBearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys.
syntic-betaYes, while in previewadmin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.

Path parameters

ParameterTypeDescription
invite_idstringThe 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
}
FieldTypeDescription
statusstringpending, accepted, expired or canceled.
expires_atstringSeven 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:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
404not_found_errorinvite_not_foundNo invite with that id.
401authentication_errorinvalid_api_keyThe admin key is missing, unknown, revoked or expired.
403permission_erroradmin_key_requiredAn inference key was used.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?