enhancedocs
For agentsOpen Enhance ↗
Reference / organisation.invites.preview

Enhance documentation

organisation.invites.preview

Inspect a team invitation before accepting it.

↓ Markdown

organisation.invites.preview

query read

Use when current organisation state is missing from the task context.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

Show complete JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"token":{"type":"string","minLength":1,"maxLength":512}},"required":["token"]}

Example

Show example input
{
 "token": "x"
}

Result

Returns a typed organisation.invites.preview result from the Enhance API without transport-specific prose.

  • teamName (required): Returned field teamName.
  • invitedBy (required): Returned field invitedBy.
  • email (required): Returned field email.
  • contentAccess (required): Returned field contentAccess.
  • role (required): Returned field role.
  • expiresAt (required): Returned field expiresAt.
  • state (required): Returned field state.
  • hasAccount (required): Returned field hasAccount.
Show complete result JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"teamName":{"type":"string","minLength":1,"maxLength":120},"invitedBy":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"contentAccess":{"default":"can-comment","type":"string","enum":["can-view","can-comment","can-edit"]},"role":{"type":"string","enum":["admin","member"]},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"state":{"type":"string","enum":["pending","accepted"]},"hasAccount":{"type":"boolean"}},"required":["teamName","invitedBy","email","contentAccess","role","expiresAt","state","hasAccount"],"additionalProperties":false}

Example result

Show example result
{
 "teamName": "x",
 "invitedBy": "x",
 "email": "agent@example.test",
 "contentAccess": "can-comment",
 "role": "admin",
 "expiresAt": "2026-08-10T00:00:00.000Z",
 "state": "pending",
 "hasAccount": false
}

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Use the returned identifiers and version in the next organisation operation.

Versions

Compatibility: 68a420434d6dc720711c5be0c5da86b1660086dad434439be9f07a328c7ee950.

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.