Agave · JSON Structure

Unified Api Link Session Structure

An Agave Link session token.

Type: object Properties: 3
AccountingConstructionIntegration

LinkSession is a JSON Structure definition published by Agave, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

link_token reference_id expires_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/agave/refs/heads/main/json-structure/unified-api-link-session-structure.json",
  "name": "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": "datetime",
      "description": "Timestamp when the link token expires.",
      "example": "2025-03-15T16:30:00Z"
    }
  }
}