Resource references

Resource References are objects used to link resources together, in order to allow navigation between them.

A basic Resource Reference is composed of:

Property

Type

Description

id

string

Unique identifier of the original resource

ref

string

API path to resource details

Domain Reference Object

A Domain Reference is a reference to a Domain object.

Property

Type

Description

id

string

Unique identifier of the Domain object

ref

string

API path to branded domain details

Example of a Domain Reference Object
{
    "id": "8f104cc5b6ee4a4ba7897b06ac2ddcfb",
  "ref": "/domains/8f104cc5b6ee4a4ba7897b06ac2ddcfb"
}

Did this page help you?