Skip to content
public-registration

Resolve a public registration link

GET
/public/v1/aggregators/{orgSlug}/links/{slug}
curl --request GET \
--url https://aggregator.example.com/public/v1/aggregators/example/links/example

Looks up a live (non-expired, active) registration link by org slug + link slug. Returns the link metadata (domain, context, schema id) that the public registration form needs. 404 for missing/draft slugs, 410 for retired or expired ones.

orgSlug
required
string
>= 1 characters

Aggregator organisation slug.

slug
required
string
>= 1 characters

Registration link slug.

Default Response

Media typeapplication/json
object
slug
required
string
network
required

Active signalstack network id (e.g. ‘blue_dot’).

string
domain
required
string
context
required

Link context snapshot (free-form metadata).

object
key
additional properties
any
registration_mode
required
string
submission_shape
required

‘account_and_profile’ or ‘account_only’.

string
public_hint_i18n_key
required
string
nullable
schema_id
required
string
nullable
schema_version
required
string
nullable
schema

JSON Schema for the link’s domain; null for account_only links.

nullable
identity
required

Identity field selectors (name / phone / email) for this domain.

object
key
additional properties
any
expires_at
required
string
nullable
key
additional properties
any
Examplegenerated
{
"slug": "example",
"network": "example",
"domain": "example",
"context": {},
"registration_mode": "example",
"submission_shape": "example",
"public_hint_i18n_key": "example",
"schema_id": "example",
"schema_version": "example",
"schema": "example",
"identity": {},
"expires_at": "example"
}

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

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

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

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