List experiences you can invoke

experiences.list() -> ExperienceListResponse

GET/v3/experiences

The experiences enabled for your account, with the actions you may invoke on each and the fields each action accepts. Treat it as the list to build against: anything not described here is unsupported and may change or stop working without notice.

ReturnsExpand Collapse

class ExperienceListResponse: …

experiences: Optional[List[Experience]]

actions: Optional[List[ExperienceAction]]

fields: Optional[Dict[str, ExperienceActionFields]]

Fields you may send in params, keyed by the exact name to use.

max: Optional[int]

Maximum length, for strings.

required: Optional[bool]

type: Optional[Literal["string", "cents", "int", "url"]]

One of the following:

"string"

"cents"

"int"

"url"

name: Optional[str]

summary: Optional[str]

display_name: Optional[str]

experience: Optional[str]

List experiences you can invoke

import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
experiences = client.experiences.list()
print(experiences.experiences)

{
  "experiences": [
    {
      "experience": "agentpay",
      "display_name": "Agent Pay",
      "actions": [
        {
          "name": "request_payment",
          "summary": "Ask the customer to pay a payment request.",
          "fields": {
            "checkout_url": {
              "type": "url",
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "note": {
              "type": "string",
              "max": 120,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "agentcard",
      "display_name": "Agentcard",
      "actions": [
        {
          "name": "attach_card",
          "summary": "Ask the customer to add a card to their wallet.",
          "fields": {
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "subtitle": {
              "type": "string",
              "max": 120,
              "required": false
            },
            "button": {
              "type": "string",
              "max": 24,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "link",
      "display_name": "Link",
      "actions": [
        {
          "name": "open",
          "summary": "Ask the recipient to open a link.",
          "fields": {
            "url": {
              "type": "url",
              "max": 2048,
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            }
          }
        }
      ]
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "experiences": [
    {
      "experience": "agentpay",
      "display_name": "Agent Pay",
      "actions": [
        {
          "name": "request_payment",
          "summary": "Ask the customer to pay a payment request.",
          "fields": {
            "checkout_url": {
              "type": "url",
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "note": {
              "type": "string",
              "max": 120,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "agentcard",
      "display_name": "Agentcard",
      "actions": [
        {
          "name": "attach_card",
          "summary": "Ask the customer to add a card to their wallet.",
          "fields": {
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "subtitle": {
              "type": "string",
              "max": 120,
              "required": false
            },
            "button": {
              "type": "string",
              "max": 24,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "link",
      "display_name": "Link",
      "actions": [
        {
          "name": "open",
          "summary": "Ask the recipient to open a link.",
          "fields": {
            "url": {
              "type": "url",
              "max": 2048,
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            }
          }
        }
      ]
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}