Get Link by Id

GET 
/links/:id

Use this endpoint to retrieve link details by link id.

Request

Path Parameters

id stringrequired

Responses

200

Get Link by Id - 200

Response Headers

• Connection

  string

• Content-Length

  string

• Date

  string

• Keep-Alive

  string

• Return-Format

  string

application/json

Schema

Schema

data

object[]

Array [

dateChanged string

from

object

class string

id number

id number

isActive boolean

isDefault boolean

priority number

subtype string

to

object

class string

id number

type string

]

messages undefined[]
total number

Example (from schema)

{
  "data": [
    {
      "dateChanged": "2018-11-08T11:35:38",
      "from": {
        "class": "product",
        "id": 24603
      },
      "id": 485377,
      "isActive": true,
      "isDefault": false,
      "priority": 0,
      "subtype": "Extrasale",
      "to": {
        "class": "product",
        "id": 27401
      },
      "type": "accessories"
    }
  ],
  "messages": [],
  "total": 1
}

Get Link by Id - 200

{
  "data": [
    {
      "dateChanged": "2018-11-08T11:35:38",
      "from": {
        "class": "product",
        "id": 24603
      },
      "id": 485377,
      "isActive": true,
      "isDefault": false,
      "priority": 0,
      "subtype": "Extrasale",
      "to": {
        "class": "product",
        "id": 27401
      },
      "type": "accessories"
    }
  ],
  "messages": [],
  "total": 1
}

404

Get Link by Id - 404

Response Headers

• Connection

  string

• Content-Length

  string

• Date

  string

• Keep-Alive

  string

• Return-Format

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 18003,
    "messages": [
      "Link with id [731085] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/18003",
    "status": 404,
    "type": "LinkNotFound"
  }
}

Get Link by Id - 404

{
  "error": {
    "code": 18003,
    "messages": [
      "Link with id [731085] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/18003",
    "status": 404,
    "type": "LinkNotFound"
  }
}

Loading...