Get one experience

experiences.retrieve() -> ExperienceRetrieveResponse

GET/v3/experiences/{experience}

Get one experience

ParametersExpand Collapse

experience: str

ReturnsExpand Collapse

class ExperienceRetrieveResponse: …

What an experience offers you. Deliberately a projection: where its templates live and how they are built is not yours to depend on, so it is not here.

actions: Optional[List[Action]]

fields: Optional[Dict[str, ActionFields]]

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]

Get one experience

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
)
experience = client.experiences.retrieve(
    "agentpay",
)
print(experience.actions)

{
  "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
        }
      }
    }
  ]
}

{
  "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": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "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

{
  "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
        }
      }
    }
  ]
}

{
  "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": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "success": false
}

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