---
id: link-list
title: "List links"
description: "List links"
sidebar_label: "List links"
hide_title: true
hide_table_of_contents: true
api: eJztWm1PIzkS/iuWtR+YXBISBhiItLtCy8wdd7OZETDalYDLOu1K2ovb7rHdMLko/31Vdr+SEALLiDlp+JJut10ul6vqecpmTnUKhjmh1QmnAyqFuh5IYR1tU8emlg4u6HuhrulVm3KwkREp9qUD+l5YR7C7pW2aMsMScGBwwJzaKIaE0cGcMjX7MPFtTjgJdEBPOIqepfhsnRFqStt0ok3CHB3QLBP4vTnVJyU+Z0AEB+XERIAhE22Ii4Fgg5sRA6kBC8oBJ8wSRj59Ojmmi/Z8aaKUOQcGhf536+fBRa9zyDqTo867q/nBolN/3X3Ma39n0b68tK1XrWeU+ANdXC3aVKCynzMwM9qmiiW4HG8jA58zYYDTwYRJC7jayu6FtYenwxXmrllBmylT4n/eA35EDVpX/9gasCjSmXJFw6uftwY4tU1ZBPVGlqZSRI3B2Gwjndb6/bC0o8NMylQyh/tOTsHqzERAhiwBsjU8Hb6qdlSoKWEkFmCYiWIRMXnXD1RdlsllWXqP6ZRRD9ouWGustQSmvO4TlklXdl69JyqSGYdRAtayKdgNZyn3JBHqPaipi+mgf88UUiTCLctdjsxEOOvjQ2XJGAzREzRMJp0lBlxmFHCSgiEpmwL922rpycTCBnqdpRDhtgXVwii/gymbCsX8VrvY6GwaF+reVe4FcsjKJVswNyKC0QaBeEdLUFmCSTUFxYWajiIDzAHGZGigbeqbwmOW8uLRu/9N/hw5cQNlI6AWEyakf4iYikDi833pwzrmshUOurRhvh96D9oJc32XnMU6k5yMgWgFxSeb7ywnN0xmYIlQuWmzJEeXB9zs2zHLQMHDlnn7xQe7LcPqVrjYL3kqbkCRIKpLftHJWCiofQ9fyERIB8Y7miJHw+Mu+WSLjwMFPxYrIE6TWHAgZYNQ1uFSlmLjSVnLxvp2hGsDxZlymzhFGcW3MbgYDKqIYkIg4QcOE6G8qsFx9C0YIuEGZOEww9NhmdNnz7KQIv1aiAy4EXPOiHHmVuXhzVcUhJFKWO7fXXIyIZi9nCbOZNC+tye5FVJitKA8daku1U+k1RpqB4NWi5wGxUJCbLXOIPqQ2laLGC2hS84AyMWplmCvtra5juw2y1ysTY7W29jLvvJ5jINjQtrupaKLqza1EGVGuJknXmNgBsxRhin84go/G7CpVhYsmnvn99/xp2mSD+M/IXJNFC6ytFakont+9kgrZ7SUIYGXqMMUJ9rwBv5gIGrlQDnPDiv6sP2nxZlXZXvkn+9zShp8Q3v1MDsYpK/odDjAazit+dA9/QKOVt2EcjAFE9BOJJiJ+k8CVYSLHA3XSu89FhqBV4i4qDv0RUkK8nmv/OfQtdKBGcMwWISDxD5sIMFfDG1DOK/nIW2asC/F287eXpsq7S2eowgyQrTDHc6J7DLPP0GLLvk1sw6jkxGlVQeS1M1ImNJ7r9KOwOeMSQx0lIoaWplNv46GZzKb3tXwKHM6YQ6Jr5yRKSjEU+BkYnRCLr25LqlXK7hQiKbRC+4gB4u+OVql0DdSDoatXCppj4PmJLt3AmatjoTfgMbycN0l8a8Z/tfQVi3xkYHoQXMdX+IwzvBdqInOf9B0qFKb3jJT/OSjjNHGkyLHZCjpc2gtBDQNkqtPLNwA4kkA8S45DsMshsWlHxp8MDfBKoWbgs/RlpHDyMrHkAIWFm3qRALWsSStCQpJd1lQ0bWIm0KcUCQRUgoLkVZ8OW0Wql61KeNcoDgmP9aMv5IqrMLFYt8Dx2uaKswbyCwfMbfKMqWzc2S8i5zdbt69YIYb9W9732dj9E7PXO4s8LcYAmkraCa5ZZZIZl3JQLvkD5TxB7mNhYRmZ2F9ziz5N+alUGy8NOf/yrVNvSJ8scQrElBWaNVIQcdF6wr6tNrzHwFt/V5vM2j7D8w63n4kZcLYZgRVinfJWxbF5BpmJGlAM0otkNnHGSM5myLS64Lb1adL864K2Gq6IOq6qZuPqap8WJGjm1McVZy/Bg9lwYeu1Ub6n7vWDZOCEzZlGDRljyacVHUEyenwAsMFt3+EB1jfD/jCAZ8FCZHTpuHwZ3njg+WCSFJtHPDNis7U6BvBwTw+PiqQZQqLXRoxB1NtZs8gymbj0bOJW9yfEWrE7REzNCiXx+9aS2HrZV62JnvoFfFcok/lDouNEoEPvOo85QEmUC9HEb2+sCSVnuvkRxDJrCPDtzoY0MO93YPXh6+jzqTP+53d8TjqHL5h+53o9eH+wcH+zmSH7dJV/J3usYM3O9Eh6xyy/n5nl+3zDuv1eh3egze7vV3W32OMNhMDbYR7v4zzfi28+42o7tO7yAHqRhitEl+ko9/zLCpgrpkYk9kIV1ydtngrjPxW0QX+NUlXXqBXFeoSLH+9g4egze6q0453HpC9xMbEni5bwjMPO0cfTwjW8oZ5azzpKONtTsDXJ6ZAmX7RHB4mwP86P/9YHCpGmiMX416P3CSB8mPSaYq7h5jn7MOPCvKCVSZgAEMMTZvnm9zJPDT5SR4UfhZr49okzhKmOgYYRx6az4UjCc5ZJLPHlBPH/vgLeC6rqAFCyvYAUwZ2qDO+uBUp4sluUHfx2t5V9VZZbAQn3PvuhN+d8GWd0C/MxRphZuov71KGoE23axBWXOdnRtIBjZ1L7WB7m6WiW6dk3UgnjVPnM/S44ET1s+fSfigIZ/DdkAj4TrSdP7wryqN//3buDeSPJgZzivoEI/W7vW6PVpDcYJtHH09w31JtXcJUDZ8b/7HQsPq8CqJmr1xj3KvtVDLhHc2bY54b7ML/ywQCWaytw/f5fMwsfDJyscDmcE+BZuTCoq9V1xDXMCsu8wNkDqhnQ/d0DFfXm/RccRe9ftgaazzqLvkeiwWtipPqJ6rylOvjtfqU99abmLRx4/vUFTznmcPapZU3vE/U9Ju439xgheGy9m871LPdZK5Xefmu9dk1/3+8sVxrtHX3upX1rvDFiHCueYEFZAzMF+sX81zQURRBWo/2JbKEUkpQ/OfbcywIm8h1B6nq9TAW0JXs+Tz0ONfXoBYLWqzG4TtWuIvFX0unur0=
sidebar_class_name: "get api-method"
info_path: docs/api/nullplatform-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List links"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/link"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List links

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"string","pattern":"^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12},\\s*)*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}]},"in":"query","name":"id","required":false},{"schema":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"},"in":"query","name":"nrn","required":false},{"schema":{"type":"boolean","default":false},"in":"query","name":"include_messages","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"limit","required":false,"description":"Limits the number of results returned per page"},{"schema":{"type":"string","minLength":1},"in":"query","name":"offset","required":false,"description":"Specifies the offset for paginating through results"},{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"query","name":"service_id","required":false},{"schema":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"]},"in":"query","name":"status","required":false,"description":"Status of the link. Should be one of the specified values in the enumeration"},{"schema":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"]},"in":"query","name":"status:ne","required":false,"description":"Excludes results with the given status. Combines with the status filter as an AND. Use status:ne=archived to hide archived instances"},{"schema":{"type":"boolean","default":false},"in":"query","name":"show_descendants","required":false,"description":"Specifies whether to show entities defined in the lower level of the NRN hierarchy"},{"schema":{"type":"boolean","default":false},"in":"query","name":"include_secret_attributes","required":false,"description":"Specifies whether to show secret attributes values. If set to true, secret attributes values will be shown\n\n> **Note:** Requires the **SecOps** role. See [Roles](/docs/authorization/roles) for details.\n"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing pagination parameters for controlling the number and order of results","content":{"application/json":{"schema":{"title":"LinkList","type":"object","properties":{"paging":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"description":"Limits the number of results returned"},"offset":{"type":"integer","minimum":0,"description":"Specifies the offset for paginated results"}},"required":["limit","offset"]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"slug":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Slug of the entity. Automatically generated from \"name\""},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"desired_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"Desired unique identifier for the associated specification"},"messages":{"title":"Message","type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["debug","info","information","warn","warning","error","fatal"],"default":"info","description":"Message severity level. Defaults to \"info\""},"message":{"type":"string","description":"The actual message content"},"timestamp":{"type":"number","description":"Timestamp of the message in milliseconds"}},"required":["message"],"additionalProperties":false,"description":"Object representing messages with severity levels"}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"archived_at":{"type":"string","format":"date","nullable":true,"description":"When the instance was last archived. `null` while the instance is not archived"},"status":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"],"description":"Status of the link. Should be one of the specified values in the enumeration"},"service_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"dimensions":{"title":"Dimension","type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":100,"not":{"enum":[null]},"description":"Key-value pairs representing dimensions. Each key must be a non-null string with a minimum length of 1"},"description":"Object representing dimensions with key-value pairs"},"attributes":{"type":"object","description":"Attributes associated with the link, should be valid against the link specification attribute schema"},"entity_nrn":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"},"selectors":{"title":"Selector","type":"object","properties":{"imported":{"type":"boolean","default":false},"provider":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"category":{"type":"string","minLength":1,"maxLength":100,"default":"any"},"sub_category":{"type":"string","minLength":1,"maxLength":100,"default":"any"}},"additionalProperties":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"description":"Key-value object representing instance selectors"}},"description":"Object representing link instances","additionalProperties":false,"title":"Link","example":{"name":"my-link","service_id":"9548393c-f1d1-4bbc-97a6-c3968862f2a4","specification_id":"5a872c9a-9a16-4a6d-a000-d0e7404a15aa","entity_nrn":"organization=1:account=1:namespace=1:application=1","dimensions":{"environment":"production"},"attributes":{"my_link_attribute":"my_value"}}}}},"required":["paging","results"],"description":"Object representing pagination parameters for controlling the number and order of results"}}}},"4XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}},"5XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}}}}
>
  
</StatusCodes>