Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
registration-links

Read a registration link

GET
/v1/links/{id}
curl --request GET \
  --url https://aggregator.example.com/v1/links/example \
  --header 'Authorization: Bearer <token>'

Full link row including counters + status.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters

Registration link id (UUID).

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
link_id
required
string
slug
required
string
domain
required
string
status
required
string
registration_mode
required
string
context
required
object
key
additional properties
expires_at
required
string
nullable
public_url
required
string
nullable
qr_url
required
string
nullable
qr_expires_at
required
string
nullable
metrics
required
object
total
required
number
passed
required
number
failed
required
number
skipped
required
number
key
additional properties
any
created_at
required
string
updated_at
required
string
key
additional properties
any
Examplegenerated
{
  "link_id": "example",
  "slug": "example",
  "domain": "example",
  "status": "example",
  "registration_mode": "example",
  "context": {
    "additionalProperty": "example"
  },
  "expires_at": "example",
  "public_url": "example",
  "qr_url": "example",
  "qr_expires_at": "example",
  "metrics": {
    "total": 1,
    "passed": 1,
    "failed": 1,
    "skipped": 1
  },
  "created_at": "example",
  "updated_at": "example"
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

503

Section titled “503”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}