---
id: service-list
title: "List services"
description: "List services"
sidebar_label: "List services"
hide_title: true
hide_table_of_contents: true
api: eJztWm1zG7cR/is7mHyQlCMluZLrsJN6NLHduk1kj2U3mYoqA94teYhxwBnASWZk/vfOAvfKN1GynMQZ8wvvcMBisfvsYneBa6ZzNNwJrZ4nbMAsmksR40AK61jEHJ9aNjhnZ6GZXUQsQRsbkdMINmDfC+ugHGRZxHJueIYODQ27ZjZOMeNscM24mr2Y+DYnnEQ2YM8TmmCW07N1Rqgpi9hEm4w7NmBFIeh7d7Y3SrwrEESCyomJQAMTbcClCNTgZmAwN2hROUyAW+Dw5s3zJ2weXS9NlHPn0BDR/+08Hpwf9L7hvclJ79nF9aN5r/16dJvXwwfzaDi0e7t790jxKza/mEdMELPvCjQzFjHFM1qOl5HBd4UwmLDBhEuLtNpG7pW0T1+drhB3SwraTLkSv3oofEsc7F18vTPgcawL5aqG3cc7A5ra5jzGdiPPcynizmBqtrHOW/2+WtLoaSFlLrkjvcMrtLowMcIpzxB2Tl+d7jYaFWoKHFKBhps4FTGXizhQbVqmpGXZGtEpo26UXZDWWGuJXHneJ7yQru68WicqlkWCowyt5VNvFdvMUuskE+p7VFOXssHhmimkyIRbprtsnJlw1tuHKrIxGtATEkwhnQWDrjAKE8jRQM6nyD6aLT2ZWNyCr7McY1JbYC2M8hrM+VQo7lXtUqOLaVqxewNzqIqM/FSOKhFqOooNcocE8NDAIuabwmORJ9Wjx9Jl+Rw7cYl1I5JtTbiQ/iHmKkZJz+ts0TruihXaXlq970eqoNWXvrMPZ6kuZAJjBK2w/lpKKoFLLgu0IFTp7oqsdNufjWQGCm8WztP33nhsDdMr4VK/5Km4RAWBVB++09lYKGx9D19gIqRD452/gpPTJ314Y6uPA4XfVisApyEVCULdIJR1tJQlrH3xoKvVGvbc0faOdAmUCRIKUcVE1a90LYY8iRvh83qW46eyrD9IBEM6+hNHNKVegiGMVsU324uUW6tjwUmUJRigQ36j61wXNtDfjTw9C16oCoxhPAMaCIUNRphz4wSXkHEXk/viDsRUaYMWYm4RdrA/7UcwZDmfDVnohhaG7CWfZagclAH5kO3e4P/bqAi+Pxlx98E7+vBIjH0IDvIDjd4d7HAbf6AF7X61TgxWm202em1c7cnHM+C1/GEiUCbAVQKJMBjTgD4887YDWWEdmeuQ+V6DuseQRXCVosFyuLCVSZ83a4ugWVzkxR6V/j8CWt9Fd1YiMmTcxkMG2sDQL2HI+reQ6+PBOe/9etL770Hvm1Hv4uuF153Hg2hjh909cuxrJJ2IDJUVWm0RWqyAXT0c3uKs530d5FwYW2KR4NYTylIn2uS70AyGcH8xscXYoBtx54wYF25VcLw+WLxK0aVoaOe2qb6CQAwaYqUr78PzCVBI6TQ4U5D61/SEKyElIY3oqaEaqr/D3t6pdjjY24NXgbEQpe7tnWH8Ird7e2C0pF0FEc5faYn2Ymc/0bHd54VLtSkDgH3qZXe9L0rQcSFtf7jG41TCXCO8lNuRFOrt3QBQSy3FGaT8EsHT8kIK0tFKzpohPqDiDiRy67x5Uf/SR1lQKDy5OmxSfoES/YZlsM4r/ASByVUzKA22iNPATGfgl/Bru/CLJDfaFIMtscqN0VcWajyRgXAgNyCr+KMPP5J26i7fBogE3dhGhx4ODZpqbwEuFbaKZU5fnUJucCLe/y0ovSFbAmMFPaUXSQrH5hcRsxgXRriZD8HGyA2ak4LS0fML+mzQ5lpZtASaBz/9RH/d9b8Y/4Kx6yqkyji1gqZ05ZURa+WMljIsqs6gae/QJunk0pQEaeVQOR8nNkja/8XSzKvgXG7g35d1tgBr7TkkWBsqyzkRVuOZnLYcxpp+oSzQdBPK4RRNSN5FRjH34Z1qBATBMrnfSP3gtpk+Jk2CP28D+LyucZTzXvjPoWvDAzeGk0kIh5m9WUAiaavgtwzfS6PdXFaJWMbfV28Pjo8jprSXeJkvkX8gOSyadVZnNZUR/1BGUByUVj3McjeDMKUHsNIO8F3BJXmAMqFgVhbTT8PhmSymixyeFE5n3JEblDOYoqKkCxOYGJ3B0ItryDxbiwnB76XBBC1hc7SKoT9UbrhUpH8SOIdiq0xpIUNidR2zJfgfQluzxFsaosRLlJsrA+OC3oWa6PKPREcsReyKm+qvHGWMNr4m5bgMhxRlUFoR6AqkZB8sXiJtKeD56cOTMMxvjEM/NGCwFMEqhhfqDyTL2JFllWOg2hnmEXMiQ+t4lrcIBae7TKjqWtlNRU4oyISUwmKsVbLsNitWLyLGk0QQOS5ftoS/MjRYtTVWeg9bd1dUYd4m51olmRrslIzR8pu0bKvuVYS5Vf/IY5+PCZ0+ZFlY4I8phvpOVeWDK25BUohbzdOHn4nGz3CVCondzhT46qar90uh3Pt7l1w/fXXZB5ok2ZHTbR/wH2HFWEiKyJbcQJenE2rtguuyHkyZGjXZBW/Xh3bmx93+Vaoh5gosYjvK7DidL7kCbVRNxaAlkydV64pwc7WnuEUocHhwsF0o8O+FIkRnxQ3jfXjK45RKFnUxKIQyRLWKZEKmCmX0CdLzQtg+ZEvzrnJwzXSB1EKBxPugplCxYk9bQHlTXWhtp835RDDFiGoNpSlecikS4FNOfqbdqbsJN3ULKPOIedQuvn8BfkiSLUqMnTYd2J+VjTcmWSLLtXGYbFfkyo2+FAma21tJE5pwNSO2Y+5wqs3sHkjZYjy6N3Lz9X6hFe7eYoZOoOqjnlZLUwNbjGY3+BC9wqrrPbuBw7zS/e1Ooj7x4dJWPqpyCM3h5A1x3UJ9gZb4nme59KsvK0fZrGebzy1Hwjru4bD2C4ctd3DIVuVk7OFfJzw+PHrYOz6K497Rw4dJ71F8/KDHHz34y9HR0TH/5njCFmKJ87XzUd6/+tMDH9l23HI2GwV9jkqLnvk1Vo1eBQTN2SjArtXtYE6/bgRdVluacsMSED5dISlwc7SqelWejRDFzsQ+97GQFH5PPHn5HKgwY7g/3LhTaeppmU1t9pch/v1OJ3hzNvPP169fVgf0sU4IzonnoxRJyN/IF3bJrcmyykTZjwr0glQmaJAsn0RbusESQH7H9JPcSPws1cZFkBYZVz2DPCG4lnM57wEM1D72NrnhE38KgElJq0rowk7i973arkPS+N6tcBJ3hkEb4i3dNclznTkGEB5/AeEXEP6+IPQLc6mm/WXqL5blnGIJtt9sX/RU3TYtjKTjMudyO9jf57not4PFfqyzzkHCGYEu4Kh9nFCLkAj5aIC6UYjiO7GofHhWFSD+9eNrLyNfahpcM+InyOmwf9A/YM2m3ImDT14+J9Xl2rqMq9b2vHintiP768aUljqWfJPS9nPJhUecF8p1Kbnz6oIvbWqpto6arq/H3OIbI+dzag7HTCTPRFjCXXOe9BZn1aXTsKsOmA/Y1nQMp1Lb9FxxZ3LzsA0yudWdxzVCC1xVRxB3ZOUu1xw38lPfr7wrQ/dcG9rIbH0d8o7M/iFuAm6xwnCtcRuQd85q7yiV+81BNi6vvHF3R0Y/4lbWZqEv3w+7I4e/5R2tjUsqr5Td1ag/5ztWm1Ud7pjdn3o//i7URn47N7U+es/4M9x22iiuTXfC7k/nn9/1p41Ca98Fu6OQPuNrQDdEa4v3oRoBXdCLEeF88JxKiilyX749vy6Hn8Qx5m1/s5SnEpU6H/nH09dUiutmDAsZQrtCSiXVhvb1dejxWr9FNZ+zes+ld6p5zuf/B6stVek=
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 services"}
>
</Heading>

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



List services

<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":{"type":"string","enum":["pending_create","pending","creating","updating","archiving","active","archived","failed","cancelled"]},"in":"query","name":"status","required":false,"description":"Status of the service. 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":{"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":"entity_nrn","required":false},{"schema":{"type":"string","enum":["dependency","scope"]},"in":"query","name":"type","required":false,"description":"Type of the service. Should be one of the specified values in the enumeration"},{"schema":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"},{"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":"specification_id","required":false,"description":"Unique identifier for the associated service specification"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filter services by name using a partial match that ignores case (e.g., \"pay\" matches \"Payment Service\")"},{"schema":{"type":"string","pattern":"^(created_at|updated_at|name|status|type):(asc|desc)$"},"in":"query","name":"sort","required":false,"description":"Sort results by a specific field and direction. Format must be \"field:direction\", where field is one of [created_at, updated_at, name, status, type] and direction is \"asc\" or \"desc\"."},{"schema":{"type":"string","pattern":"^(?:[a-zA-Z0-9_-]+:[a-zA-Z0-9_-]+(?:,[a-zA-Z0-9_-]+:[a-zA-Z0-9_-]+)*)?$"},"in":"query","name":"dimensions","required":false,"description":"Filter services by dimension key-value pairs using case-insensitive partial matching"},{"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"},{"schema":{"type":"boolean"},"in":"query","name":"has_links","required":false,"description":"Filter services by whether they have links. If true, only services with at least one link that is neither archived nor deleted are returned. If false, only services with no such links are returned"},{"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":"link_entity_nrn","required":false,"description":"Narrows has_links to a single entity. With has_links=true, returns services that have links matching this entity NRN prefix; with has_links=false, services that have no links matching it"}]}
>
  
</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":"ServiceList","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 service. Should be one of the specified values in the enumeration"},"linkable_to":{"title":"Visibility","type":"array","description":"Array representing visibility settings for the entity. Specifies what/who can see this entity","items":{"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"}},"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 service, should be valid against the service 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"},"type":{"type":"string","enum":["dependency","scope"],"description":"Type of the service. Should be one of the specified values in the enumeration"}},"description":"Object representing service instances","additionalProperties":false,"title":"Service","example":{"name":"my-service","entity_nrn":"organization=1:account=1:namespace=1","specification_id":"67fac146-54cc-466d-8c52-a8234445a95f","linkable_to":["organization=1:account=1","organization=1:account=2"],"attributes":{"my_string_property":"my_string_value","my_number_property":0}}}}},"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>