---
id: scope-type-list
title: "List scope types"
description: "List your scope types for a given NRN."
sidebar_label: "List scope types"
hide_title: true
hide_table_of_contents: true
api: eJzdWF1uI7kRvkqBTzNCS5Zl2TNuYAI449nEm8AY+Ae7gG0M2GS1muMW2Uuy5dEKDeQh73uHPUVynb1ArhAUuyW1ZFnWeDYJkBf9dJNVH4v1fUXWjJkCLffK6DPJYuaEKbDrpwXGuXKeRczzkWPxDbukN0Bv2F3EJDphVUHzWMz+qpyHqSktuMUoB6mxwGGkJqjh/OK8xyLmUJRW+SmLb2YsQW7RnpQ+Y/HNXXUXsYJbPkaP1oUBimz/VKKdsohpPkYWM2012REZjjmLZywAipnzVukRq9aRfadyMreCy2fcw5h7kQEhtAhjYxFcgUKlStB7DT5DKKyZKIlyjh6/8HGRkztjR1yrn0Pc3u3HXAhTav9uEBNKV3CB7w5iXhS5EvWYIYuYxZ9KZVGy2NsSq2jzAp3nvnRb1hgx1OWYtoQLrybIIqZ08/OuartJee5wPSKXwT6YNCxxGZceewpRcL8LHlE6b8a7gLiaFvg1EJqdsJ92xuLQTpTYKSIfG+MBw4tQKbkVU2rsmHsWs7JUkn0FoLPTDXBu9a3+A/z293/+6x+/QKdzbjzGnQ5cZcqBcq3R84QOGQhnp6spfJweJEO+P+ge4eC4O0ze7HePB/Jtd3go3uAglcfpwdGTKw9fW2n4XAJkCGQEpHJFzqcowZuAXeIEcxIlR0+URO1VOn20J+2lfPjLJby3Rn9vkicRKy3yUu6Yx7zgicqVV+h2SaCz2rYDLqWiZzwHyT2H1JpxW0ksSEyVDmNWl7DikqTQoiuMdugI6KDfp6/HIVyINzxwB64UAp1Ly5yMC6M9ak8TW0q099nR7FkrDIUlM8FzPGNKtkKjy3GClm3avY252V7T/uBgeFhFQbE3BHvV4vnFObzingQ5wdw8vIaHDC0G+6s+ICwG3TcLchU1mJ4XtE3rn4vFU0nZzK3mGfhcBF7EiAAiINjGiFVPzwG5zIz10HpGq8zMw/o+PBh772jDHqieKg/SrO/KKRa5mUKBVhmpBHw2iQOl4b5M0Gr0lOvRvOJ9XaFbR/1Dhj4jDScZbKFUDlDzJK/DmSCUDuUqysZkFa2VmV2qyzqMU+I3NipsSisQaLv8tD51KHI5Ru3dVkGbm29DWuHlE6VlO08XIhSgFOYhZNQiXqGwrJeVW/3b336FTudkhNp3Ey7uUdbDXV10EDqd6+uz005nVQ5Wi8/UlCAsco+yB3CroS5XNJF2yKIvrUZJpK8HB51E4KDxYaNFriVw4R1wV588i2XRXCt0+HbID8VB90gMsDtM9w+7x/2k390XR29SefAmPcK3rCI1UD5MCCddOqFcNBrMqoreD3/88bEKv88Vag9orbGwEG2QJQay6gnPlQSlizKI21g5p/QIlifdr5LqZvtN8hmFXzlS3jQ0em9CkQt4WMTG6BwfhURdlfnW6KVdpT2ONuj9n6+uPkI9A4SRCBYLi44yW4/qTZ8fnkU7Hq+wN+pFMOz36WOfPg7oY/h6ZYuG/X5FQZA7yOQJjLnIlMauRS6J2I2vgCtktuAeR8aqn+c8RDtBCylXeWnXmJZw+YmCiM4T2+qw7QAisQrTCLJyzPUSyZpokvMaXJCiJhq37I9cwkXt9JbRg2vNS58FyPKWrQanPZogznf0eZCtwwh6rnIHPDGlX8Ja9UNcbkIRThNjnpO6oIQQXe25IorOU7qdwVVVM+RwE0Mu6/CvM0RpGfJcj4BrUM6VCKa+d518PAOnJP6fUcO1A9EkwyFR47A/oI+D1Y0//N+xghZrNc8/1YM+1SH7r/HjrHEPTep8oDE1Uy7rygjXmk+4ysnqI8JsnP4fpc6JhlLjlwKFR9ksyQhRWkv17mOO3CF4OwU+4kpDzj3aOWsCLp8Z6r6MkDK34NQRYXuh7C1uvGEtdV+ktDmLWeZ94eK9PV6oni7zvMi5J8L2BB0775bNlkviSJ3a7ZbLIghkaH4vCpoYBrGo+fHd/Ijx/Q9XoU4qnRqaTnjqeO33+r0+W1bQ8xYcYnM4yBjnxzyQtrmSha5RqzGzvg2zJfl37zA1a/L4xe8VOVeafIeAzZrA3rBWYO8ilhnn6elslnCH1zavKnpc3x8p3FK5cIDcfPtro3x10YjOa/hdG08bF3WP00U/bMLzkkaE6+/ueJ/uBW31uWhRvdDtU92frU4bHrzQ5bM9nq2+19tP3wri9+/r7AI+XBBeumXf3q/ZlsR1O+mF2F7cftmCaNkuWoK6oz9WEarQsI5YhlyiDSJRTzsRAgvfmvXozEJWFnr/pw9XLGJ8VY7X5DdYb15xPW3Zns3qEVfmHnVVsQVT6D+r7qqq+jcslkD7
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 scope types"}
>
</Heading>

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



List your scope types for a given NRN.

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

<ParamsDetails
  parameters={[{"in":"query","name":"nrn","schema":{"type":"string"},"description":"Filters scope types that match or are more specific than the provided NRN.","example":"organization=1:account=2:namespace=3:application=4","required":true},{"in":"query","name":"status","schema":{"type":"string","enum":["active","inactive"]},"required":false,"description":"Status of the scope type."},{"in":"query","name":"type","schema":{"type":"string","enum":["custom"]},"required":false,"description":"Type of the scope type."},{"in":"query","name":"provider_type","schema":{"type":"string","enum":["service"]},"required":false,"description":"Provider type of the scope type."},{"in":"query","name":"provider_id","schema":{"type":"string","format":"uuid"},"required":false,"description":"Provider ID of the scope type.\n\n> ℹ️ **Note:** This is the scope specification ID.","example":"9f3b4a12-6e29-4b71-92d8-45c7e2fd9f36"},{"in":"query","name":"name","schema":{"type":"string"},"required":false,"description":"The name displayed to the developers to identify the scope type.","example":"EKS CronJob"},{"in":"query","name":"include","schema":{"type":"string","enum":["capabilities"]},"required":false,"description":"Includes additional data from the provider definition.","example":"capabilities"}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"properties":{"id":{"type":"number","description":"The ID of the scope type.","example":12345},"nrn":{"type":"string","description":"NRN (at or below) where the the scope type applies.","example":"organization=1:account=2:namespace=3:application=4"},"type":{"type":"string","enum":["custom"],"description":"The type of scope type.","example":"custom"},"name":{"type":"string","description":"The name displayed to the developers to identify the type scope.","example":"EKS CronJob"},"description":{"type":"string","description":"Short description of how the scope type works or what it does.","example":"Deploy periodic jobs in kubernetes"},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this scope type is enabled to be used.","example":"active"},"provider_type":{"type":"string","enum":["service"],"description":"Defines the source entity that implements the scope type.","example":"service"},"provider_id":{"type":"string","format":"uuid","description":"The ID of the provider that powers this scope.\n\nℹ️ **Note:**\n• **Agent-backed scopes:** The **UUID** of the scope specification you created.  \n  This UUID is returned when you define a new scope specification and acts as your provider ID.","example":"9e84a5c3-6c2e-4f15-90b0-1c67fd37f6e8"}},"title":"ScopeTypeResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>