---
id: provider-list
title: "List providers"
description: "Get a paginated list of providers filtered by [NRN](/docs/NRN) and other queries"
sidebar_label: "List providers"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v4zYS/isEcR+yd1IiyXZiGygOi27by2HhW2SzaNHUXVDSyGYjiVqSSuoG/u/FkJIsyS9x0hxyB+ynxBRn+MxwXh6NHqgoQDLNRX4Z0yktpLjjMchpypWmDtVsoej0hn6o1uncoTGoSPICZeiU/gCaMFKwBc+ZhpigIBEJqTUpkvBUg4SYhCtyM7uazU/OYhGps9nV7A1heUyEXoIkX0qQHBR1aMEky0CDxKMfqIqWkDE6faB6VQCdUp5rWICkDs14zrMyo1N/7VCOcFDLijo0ZxluTXnG0Q4JX0ouIabThKUK+ka8x22K6CWQvMxCkGiBBFWmWhEJupQ5xKQAiYYCXTvHofL2oBJJouAIWB8LiHjCwSKzUiQRsnY3zxdEL6UoF8sabR8b1ymeeBnjZVqgSkueL6hDEyEzpumUliXH593DP+X8SwmEx5BrBCHNyQgEF/SKSCgkKMjx1pkijHz6dPmO7jHZHNAzdzfU2dVsB9aCaQ0SFf8q5ILl/A8TtN/ceO7k7/N/nExZFIky1/XCm3+eTPFoVbAI2ousKFIedYRxWUWiaO3725Y7ZmWaFinT6DRyBUqUMgIyYxmQExPJjTvwVhhZcpBMRksesbTvxLytS1a61D7X5TLv+E7Lco/r3vEMcsVFrnZ4sGvOZmtzreZYh9ioqC71FlbTO5aWQArGpSIKMDm1TeZIZBlT5AROF6cO+YXewsq3u33nFlaB/T/4hb7ZZ1rcBnw4OnrWwO8sK4zRF8kgmvgeuGN/MHaH8fnIncTexA0nF/F4kgTRyJs44wAAhkHkDs+jiTsMwwuXjQaxG3nj0Asuxv5FMtgHUtkstDHzeVcg951bV0vysS1KLt8RLapySMKVQ7gmqiwKIbWyzmz51/huK533eoHdKzcSecIXpS3nzoLrlIXdxeNMVGm5eLaRKPxCZoZCpMByE7sJK1PdRMZuI5bi/jNihDxmud4RUvvr6/0STBPSgqAaW+LwQQwJx9rPc5MjqbgHSVK4gxRbBC7NrmZNsq9ezhD2P2gHk5IhTq4hU6/UXo6J4GMafpelENXLVNWJ4WPd0U/PHFnAjWVRDl1IURaKzvfZwPMoLWN4HP1brSUPSw0GZSVWX60EVYhcAV3PHaogKiXXK0OkQmAS5NtSL+n0Zo6P670GffDTT/inl+X7iR11aCRyDblGsVZfPftNoeyuDlUXjfcVvbQOE+FvEOHvQiIdxYBFIcNyFi3H7tlnSd5hfvgsxoflsuJqh3neU4kbxBu+tm5f903DWKtz5+ax3fp45DUOYnHMEQtLP7RcVQVT13s8fjWiiMzmK/OzzG+LZbzWpbCmuOwKrN0cwK3Rk410v+V0K2xVGtZOmwM+et7sarY5aiN4Sm6ugMUkExLqt8vNU8M+7YvsVgJ11V+zhSJMKRFxk6P3XC8N9rrmHUq5blbdwmpXR9g6Dxk24jM86DgJuxV7yGsFSa9koQm1BQbV/GABQvGqFR7dS9dbYwej4PBlrR0aScCHn5ne5dvGOzHT4GqewZaLvkUFGLD4VGmWFai2LOK/pvY9U5pYLW3NGKi9TomBvSX+HxN0/cLTkJm6sLTfEGyhp2yQ+FEQD10YhefuxXjiuSz0AzeKIRkMR+e4QqvKTDv11m8Krd+qrz7tZzDkd1yKPDO8ALMiLqP63WO7yFEvSOIgSHz3PEwm7tBnzJ2Eo7EbTOKRl1wEo/FoRPtVKUpLpUE2VmUrNy/cRVS4eB51aCoqJjilyr0Hpf2KZhnUlUTzEwOSabhnJmeLMkx59LkiZdnKtQtuvQVTnd8xDe0tdqXZs25Kzk0FcQjBwDuPwR0HMHCH4cXQZUN/4oIHg2AYQjjy0PGmbtT2nZqcrUpD30jkb+3wpoEXDF3fc/3RtTeeDryp5/1Mu7Ha7Am8a384HY7Mnl46m0Pt0GHHq2/rIjrndw6ar/s1ouJyGzKzNUg8xDTXRt9wF0H93iSbKVyddAAphVQkLjEpydsPlwSJm2QmFp/FXb9DjY+SVqWZLtW3Im5Xc0sxt9L4X9fXH4gVIJEwFD42OMxcD6wNpox11e1pDlU5N1JWn/VKAhLyCMysNWIaFkJWSY267SGPKv+4FFI7ZFlmLHclsJiFaX0WShI80yo3DS0DpXBW+qjid6AZTyGudFVy1eWbwta0EmLu7Hdt0uuFwqAdpK27q/2yMWRug3D0NQi/BuHrBqExTC8FtpWF+Y5QMHynp2ctnqpA3tVfUEqZ0ildal2o6dkZK/hp+z3kNBJZZ1jwEaPOBlJ7ZND4EBXhCWYbjrfMJupU/3xf059//3hdzWsSsWsIgJYjRus879Q79fHSCqF0xkz8Vw3WTGvac4eO2x82WfTf+BpVGY1XflakjJt4NR59qPx+03w2w662FErj2sNDyBR8kul6jct21oO3EXOFYbtnuNO25omfpfZgtZSinivUbMKMtI6H8pxPUQfxNN/ADgOymzs86InIT66q5HpDDiOylOcYOJ3PFs+E9YLfCA5atYPCvSzi5w38n4C5+hzxlwP3xWbjh7Fvf4X4f0LOXgD4U4frx8fC8zEdNzI/iGQznt9gmOMPyRGEmak7dAkMGwEWeiv2NoqgaBe6LaKHWpqG/sN31/iW1e24vQ5rtNeDk3zV0v3wYHdci1vI1+vmhVLjb7pG+vAn3KTE3g==
sidebar_class_name: "get api-method"
info_path: docs/api/providers
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 providers"}
>
</Heading>

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



Get a paginated list of providers filtered by [NRN](/docs/NRN) and other queries

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

<ParamsDetails
  parameters={[{"schema":{"type":"integer","minimum":1},"in":"query","name":"limit","required":false,"description":"Limits the number of results returned per page"},{"schema":{"type":"integer","minimum":0},"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":"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":true},{"schema":{"title":"Dimensions","type":"string","description":"Dimensions for the query, formatted as key:value pairs separated by commas (e.g., \"key1:value1,key2:value2\")"},"in":"query","name":"dimensions","required":false},{"schema":{"type":"string","example":"7f3c910e-8138-4d65-9d09-b97d89f2c509,82eee42c-46c9-4bb7-a53d-c08b027817f3"},"in":"query","name":"specification_id","required":false,"description":"Provider Specification ID to filter by, it supports comma separated values"},{"schema":{"type":"string","example":"aws-configuration,gitlab-configuration"},"in":"query","name":"specification_slug","required":false,"description":"Provider Specification slug to filter by, it supports comma separated values"},{"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":"show_ascendants","required":false,"description":"Specifies whether to show entities defined in the lower level of the NRN hierarchy"},{"schema":{"type":"array","items":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"}},"in":"query","name":"specification","required":false,"description":"List of provider specification IDs to filter by"},{"schema":{"type":"array","items":{"type":"string","enum":["tags","groups"]}},"in":"query","name":"include","required":false,"description":"Attributes to include in the response"}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Paginated list of providers","content":{"application/json":{"schema":{"title":"ProviderList","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","additionalProperties":false,"properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"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"},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"attributes":{"type":"object","description":"Provider-specific attributes defined in the specification schema"},"dimensions":{"type":"object","description":"NRN-specific dimensions. [Read more](/docs/dimensions)"},"tags":{"type":"array","description":"Tags associated with the provider","items":{"type":"object","properties":{"key":{"type":"string","description":"Tag key"},"value":{"type":"string","description":"Tag value"},"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"}},"required":["key","value","id"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"string"},"description":"Groups associated with the provider"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"}},"title":"ProviderRead","description":"Object representing a provider resource","example":{"id":"a3f1c2d4-e5b6-7890-ab12-cdef34567890","nrn":"organization=1:account=1:namespace=1","dimensions":{"environment":"production"},"specification_id":"02fd22f1-6bf9-41aa-9b58-29d50f725855","attributes":{"cluster":{"id":"my-np-gcp-prod","location":"s-west1","namespace":"my-namespace"},"gateway":{"public_name":"my-public-gateway","private_name":"my-private-gateway"}},"tags":[{"id":"4e2306de-82e3-4b74-a419-e0e324beb500","key":"cluster.id","value":"my-np-gcp-prod"}],"created_at":"2024-10-15T08:30:00Z","updated_at":"2024-10-20T14:45:00Z"},"required":["id","nrn","specification_id","attributes","created_at","updated_at"]}}},"required":["paging","results"],"description":"Paginated list of providers"}}}},"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>