GET /portal-links/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- icon string | null
  
  Icon
- id integer(int32)
  
  Id
- name string Required
  
  Name
- portal string Required
  
  Portal
  
  Values are vendor, returns, or reeller.
- updatedAt string(date-time)
  
  Updated at
- url string Required
  
  Url

curl \
 --request GET 'http://api.example.com/v1/portal-links/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "icon": "string",
  "id": 42,
  "name": "string",
  "portal": "vendor",
  "updatedAt": "2025-05-04T09:42:00Z",
  "url": "string"
}