Agave · Schema

LinkSession

An Agave Link session token.

AccountingConstructionIntegration

Properties

Name Type Description
link_token string Token to initialize the Agave Link component for the user.
reference_id string The reference ID associated with this session.
expires_at string Timestamp when the link token expires.
View JSON Schema on GitHub

JSON Schema

unified-api-link-session-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/agave/refs/heads/main/json-schema/unified-api-link-session-schema.json",
  "title": "LinkSession",
  "description": "An Agave Link session token.",
  "type": "object",
  "properties": {
    "link_token": {
      "type": "string",
      "description": "Token to initialize the Agave Link component for the user.",
      "example": "link-token-abc123xyz456"
    },
    "reference_id": {
      "type": "string",
      "description": "The reference ID associated with this session.",
      "example": "user-789-procore"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the link token expires.",
      "example": "2025-03-15T16:30:00Z"
    }
  }
}