Skip to main content
GET
Get link-type service relation

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the records.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
service_relation_id
string<shortuuid>
required

ID of the service relation.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A GSRN service relation as read from the API.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gsrn
string
required

Global Service Relation Number (AI 8017 or 8018), exactly 18 digits. Unique across Closient.

relation_type
enum<string>
required

PROVIDER for AI 8017 (the service provider), RECIPIENT for AI 8018 (the recipient).

Available options:
PROVIDER,
RECIPIENT
service_type
string
required

Optional descriptor such as 'broadband'; empty when none.

Maximum string length: 120
organization_id
string<shortuuid>
required

UUID of the organization that owns the relation.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.

external_url
string | null

The provider's portal or account page, if any.