List link types

GET

/v1/link-types

const url = 'https://api.aerandil.com/v1/link-types';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/link-types \
  --header 'Authorization: Bearer <token>'

Schema-discovery surface for typed edges. Each entry names both directions (from_role / to_role) and the cardinality (one_to_one / one_to_many / many_to_one / many_to_many).

Authorizations

aerandil_oauth
objects:read

Responses

200

Sorted summary list of every registered link type.

application/json

object

data

required

Array<object>

object

api_name

required

string

cardinality

required

Wire shape follows format!("{:?}", Cardinality) then .to_lowercase() — single token, no underscores.

Allowed values: onetoone onetomany manytoone manytomany

description

string

nullable

from_object_type

required

string

from_role

required

Name of the relationship as seen from the from object (e.g. guest on a reservation’s link to a guest).

string

to_object_type

required

string

to_role

required

Name of the relationship as seen from the to object (e.g. reservations on the inverse link from guest).

string

next_page_token

Opaque cursor for the next page (AIP-158). Reserved for future growth; v1 returns null because the registry size is bounded.

string

nullable

Example

{
  "data": [
    {
      "cardinality": "onetoone"
    }
  ]
}