> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/links/object.md).

# The link object

A link object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/links` endpoint.

## Fields

| Field                            | Type      | Description                                                                                                                                                                                         |
| -------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                         | `string`  | `links`                                                                                                                                                                                             |
| **id**                           | `string`  | The link unique identifier                                                                                                                                                                          |
| links.**self**                   | `string`  | The link endpoint URL                                                                                                                                                                               |
| attributes.**name**              | `string`  | The link internal name.                                                                                                                                                                             |
| attributes.**client\_id**        | `string`  | The link application client id, used to fetch JWT.                                                                                                                                                  |
| attributes.**scope**             | `string`  | The link application scope, used to fetch JWT.                                                                                                                                                      |
| attributes.**starts\_at**        | `string`  | The activation date/time of this link.                                                                                                                                                              |
| attributes.**expires\_at**       | `string`  | The expiration date/time of this link (must be after starts\_at).                                                                                                                                   |
| attributes.**active**            | `boolean` | Indicates if the link is active (enabled and not expired).                                                                                                                                          |
| attributes.**status**            | `string`  | The link status. One of 'disabled', 'expired', 'pending', or 'active'.                                                                                                                              |
| attributes.**domain**            | `string`  | The link URL second level domain.                                                                                                                                                                   |
| attributes.**url**               | `string`  | The link URL.                                                                                                                                                                                       |
| attributes.**item\_type**        | `string`  | The type of the associated item. One of 'orders', 'skus', or 'sku\_lists'.                                                                                                                          |
| attributes.**params**            | `object`  | The link params to be passed in URL the query string.                                                                                                                                               |
| attributes.**\_disable**         | `boolean` | Send this attribute if you want to mark this resource as disabled.                                                                                                                                  |
| attributes.**\_enable**          | `boolean` | Send this attribute if you want to mark this resource as enabled.                                                                                                                                   |
| attributes.**disabled\_at**      | `string`  | Time at which this resource was disabled.                                                                                                                                                           |
| attributes.**created\_at**       | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**       | `string`  | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**         | `string`  | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin** | `string`  | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**          | `object`  | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**item**           | `object`  | The polymorphic item associated to the link. One of 'orders', 'skus', or 'sku\_lists'.                                                                                                              |
| relationships.**events**         | `array`   | The associated events.                                                                                                                                                                              |
| relationships.**event\_stores**  | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                    | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.commercelayer.io/core-api-reference/links/object.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.