---
id: scope-type-read
title: "Read a scope type"
description: "Read a scope type."
sidebar_label: "Read a scope type"
hide_title: true
hide_table_of_contents: true
api: eJzdV9tuGzcQ/ZUBnxJhLcu3XBbwgxunrVPACHxBAtiGMSJHWsYrckNy5SjCAn3oe/+hX9H+Tn6gv1AMdyWtLrVTFG2BvqzlXXLmzJk5Q85U2IIcBm3NiRKp8NIWtBUmBaWOUIlEBBx6kV6Jc/4C/EXcJMKTLJ0OE5FeTUWf0JE7KkMm0qub6iYRBTocUSDn4wJtRCoKDJlIhMERiVRotu1lRiMU6VREu6nwwWkzFFUiHH0stSMl0uBKSoQiL50uGKhIxUVGcHIMdgAhI/BzaF2RCPqEoyInke7s7u0fMJrlvWeECnBlkyNfWOPJM5jdXo//rLuccwX36MGXUpL3gzJnC9KaQCbwRiyKXMu4cPuD593TVqiFYzNB1760aoVvylGfnPgb0SbCOLNO6KrF07NTeIIBrIM+5fb+Kdxn5CjaX/YBMRjyS76EdUM0+nMM8XAnRSltacLhbsrZ9QVKOtxLWzQc7nNOa0zr2MiUIy4xWfpgR2ItYxx/xGIHfxb9bG81K7DHGGCbvBKU9kWOE1IQbIxd0ZhyTpHnN1qRCXowqalhEBHBsvPXP5zDK2fNG9tnBEueHgNynlkXoPWOo8zs/Woe7q2785yw+wwD6ADKrmblmIrcTqAgp63SEj7Yvgdt4K7skzMUyDM6HzCU/qE8oAx6TCIR2jQ/11LyLqOQkYOQad9GqT2QwX5e09knKD2pZZSNySphJYy1Inf7WGF4cmMtN8A4poE25GuubOkkAacrcLqYJXY5IhP8Q8qZm29DWtLlHNDAuhEGkYqyjA3sIZ3OTNVQCnsfK2rOV/faXJsvP/32+68/Q6dzagOlnc61+fLjL9DpHA3JhK0+yjtS9XKfdjrADjqdy8uT405nuR34gqQeNGqDiS1BOsJAqgtwbQAu2C9v5Aw5CqUzpFj09WIVeQQEQ/cbLaJRgDJ4QM8b3CK6k+NlMl/Si308kHtbz+Qube0Pdg62Xvb6va0d+ez5QO09HzyjF6LibqBD3BAPlotJQWdNDxZVxd/3379f78Kvck0mADlnHcybNqiSoljNGHOtQJuijM1tpL3XZgiL8+gvteom/bb/gWQQ7UPpqpHRK6tYKBGPSMSIvMdhLNTlNt9avbCrTaDhhn7//cXFW6h3gLSKwFHhyHNlm2Gd9CY5INt8PKHusJvAfq/Hjx1+7PFj/+lSivZ7vYpJUF/RJo9ghDLThrb4OsDCbnxFXLGyJQYaWqc/z3RIbkwOBqjz0q0orY/qlkkkH1htNW1fAaLvNA0SyMoRmgWSlabJzmtwsRU1bFyLb1DBWe30WvCLS4NlyCJkdS2WyWmvZoizjD4OUinNPzEHRQF17gH7tgwLWMt+WMsNFfE2McKcuwspiOyagJolOivpdgVXVa2Qg00KOa/pX1WINirWuRkCGtDelwTWRHBHb0/Aa0X/M2n4NhFNMRywNA56u/zYW078wX+nCg7WGcxv60W3NWX/mj5OGvfQlM5rXlMr5bw+GeHS4Bh1zlbXBLNx+z8qnSMDpaFPBclAqgnJSlk6x+fd25zQEwQ3ARyiNpBjIDdTTcQVMsvDzpC4cuNckorteOzFq8j2VKuKx5MYUD3ClC4XqchCKHy6vY2F7poyz4scA6u2K/nu2ZqLzlkodX23p6M5E2xoNgDFxhgXiaT58e3snvHm3UU8LLUZWN7OeGrSdrq9bk8sjtHTFhyWdLzNWB9GGJXbjF1rw89qMqaLFrB5UmoCCPQpbBc5asOOIjvThsorsaBSJCLVikWfWR/423TaR0+XLq8qfv2xJMdT5E0ixug0V1jkW2kfr5EiHWDuVwfANsonZ03reQoPDUobcTcv0UwE+89L/k8k4o4m9Yxa3VSJyAgVuQir/nAkJRWhtWWtV3ItzOvsu9cXIhG4XAErGY/WN8KZTusVF/aOTFXN0QX+nwFW1R9voHBA
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={"Read a scope type"}
>
</Heading>

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



Read a scope type.

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

<ParamsDetails
  parameters={[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the scope type.","example":12345}]}
>
  
</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>