v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB

Loop Links

Get a Loop Link

get/v1/loop/links/{link_id}

link_idstring required

An existing Loop Link ID.

Successful Response

link_idstring required

Loop Link Identifier.

E.g. ber7ntO0ZHuFVCfrSNsN

expire_dtstring date-time

Date/time the Loop Link is set to expire in ISO 8601 format.

All dates are in UTC.

E.g. 2023-05-08T00:29:45.859Z

metadataobject

Metadata can be used to further identify Loop Links in a way that makes sense for your system.

The field is a key/value field that accepts string-based keys and string or numeric values.

This can be useful for storing additional data such as a end-user identifier or store ID etc.

namestring required

Name of the Loop Link. This is for your own use as a way to differentiate your Loop Links.

E.g. Hotel ABC

status'active' required

create_dtstring date-time required

Date/time the Loop Link was created in ISO 8601 format.

All dates are in UTC.

E.g. 2023-05-08T00:29:45.859Z

update_dtstring date-time

Date/time the Loop Link was last updated in ISO 8601 format.

All dates are in UTC.

E.g. 2023-05-08T00:29:45.859Z