Get one experience

client.experiences.retrieve(, ?): ExperienceRetrieveResponse { actions, display_name, experience }

GET/v3/experiences/{experience}

Get one experience

ParametersExpand Collapse

experience: string

ReturnsExpand Collapse

ExperienceRetrieveResponse { actions, display_name, experience }

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?: Array<Action>

fields?: Record<string, Fields>

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

max?: number

Maximum length, for strings.

required?: boolean

type?: "string" | "cents" | "int" | "url"

One of the following:

"string"

"cents"

"int"

"url"

name?: string

summary?: string

display_name?: string

experience?: string

Get one experience

import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const experience = await client.experiences.retrieve('agentpay');

console.log(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
}