---
id: provider-specification-read
title: "Read a provider specification"
description: "Read a provider specification by ID. The JSON schema attribute defines settings for any [nullplatform integrations](/docs/providers/supported-integrations)."
sidebar_label: "Read a provider specification"
hide_title: true
hide_table_of_contents: true
api: eJztWN1u2zYUfpUD3iwJZLsbthvdFU27ecjSoHGwAokRHIvHEhuJVMmjZK5hYM+yR9uTDCRlW0rspMM6ZAN6ZUs6/M4Pv/NDLoWpySIro8dSpKK25lZJsteupkzNVRY+pZZQikQw5k6kl+KslYLzrpSYJkKSy6yqw2Mq3hFKQFiDQg8UZgsYHw9hUhD8fP72FFxWUIWAzFbNGiaQNFeaHDhiVjp3MDcWUC/gUjdlWZfIc2MrUJopjz646cFImsyN1irdyDV1bSyTHHTlDociETVarIjJeqeWIuoX6VKw4pJEKsbB6UXt/zu2SuciEV4nskhF0yj/ve/yhVYfGwIlSbOaK7LBaC4I/AtegKXakiPNJAEdIFxcjI/FKhHKL6+RC5EIjZXXGfAtfWyUJSlStg2tpolwlDVW8SJYPSO0ZF82XIj0cuo/W3K10Y6cd+W79+/9T9/It7MPlPHWFKXz/dtkyZnGZiQSkRnNpNkDYl2XrcTog/OovQDGmJmgRyQCpVReFMsz6wnHyls3x9JR4jm3ebX0Pj/XDsSoLx/o6+OfYkVg5gFxd8g8liub/Gms1lYvvLFyP6bKYpwfxxxnRn8GWG/RU5jH26enXb9VTs1KumbTAUZrcSESoZgq91DhfYPEiXLsVZ2+O3XAhXL3WKkctHqATQj4XvL1gS9DrTkP0tODgrl26ShQeBAhhsbmI3NL9lbR3eiuQB4oN/AC8fvhE8EdXulJsDeWs3+1iF3pMUOGGrB0BpTOykYSZI1jU0HHUbihxZ2x0oFrsgLQpVf6Sv/5+x9wdMSYHx3BwcyYklAfpvAL2hsX64HPy0VIkobNgDHPcVZSEh4rZJVhWS4gs4RtDWHM4U5xsY5PAPjGwS2WDQ23Sh1llvhpvVEuAdKu8UTZievJoOmWLFi6JSxJdjTl1jS185oCBQ/TddMiB5nRc5U3MZwQJYP5SgdFcQv3uusoC/sArfjFeHgVMgDL0txdS1WRdl6gw8rW3Qe0fFNiDmwgLIXt0pZs9/kfE2aOTcm79exh/3Fc81DBYwkd2/6DVO4jTzB3gM6ZTKGvrF0WRBbvyP6Nlf0ecEOLp2vSBHNP61BxPAs+b0UU9cX0ufrMqtvSL4Ovaw+CVdNH26VfniFTbmwbrL0F9jla6L1WdOx8De+womN6kK5JS9LZ/9GVnvGrRBibo1afQtZct+yKpoaaTdbPdU1Z+goaZ7n7Ot52EGB8DFwgg7nTuxrgEE4vTk6gItQO8tLMsISDbkcZVKgxJ3nobQsli+Q18q4s2URQItOAVUUPwvgq1DyjwX91jFXtYZta/jPYE3QMEaWL7GtOu+Xro0bvpPEuHke+zFDbTcZAoDAGthPcZq7YUdR7Ye0FY7paeR++3zV7vwlRCSzsmUrWGutAxjb38mwcRgKLscX8reG7Dd1rj7hNmD211jFy414Z2S2guqlmgbB923+aTM4gLoDMSAKlZbCjbczBh8C3Ptzj029YFfFiVOZkSWcEqLcF49OmG0UlT4KfF8ZyAkVToR7486vPu1aXXwleZwQPPaQi5zD/DKuPiVGVJFusdl1LtEC6TfWGsGe/cWD0F6JBl66dvVvHZetIS8IfvpLwKwmfl4TBMS6Mv2DKKey+v+ZIxWj3ddNoqeTKl16yt+vLmcaWIhXr4xrWathtdsPMVKJ7NRKOPZFb3QuSTVg90Lq4h7E8CImk/fNm3bp+/nUS4qb03HRpfdYZar2NMZ4vhi+G3/p9rI3jCkNKtFc5j16F3d/e5TbP/ut3aG08PcFGdYkqZEfYrGW7y5d7LhVFItI47hbGsZdbLmfo6MKWq5V//bEh6++4pn48tirOTZdLIZXz/+XmAmlv7A7etTw9hH2mrkdOvZ3CUyGSeATx88BqukpEQSjJBu3xw8sso5o7Sx5UQ8/GDet/fD3xE0Sfg/c4F9B3mrNcRomJuSG9Wm2sY//sDVyt/gL6gLyC
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={"Read a provider specification"}
>
</Heading>

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



Read a provider specification by ID. The JSON schema attribute defines settings for any [nullplatform integrations](/docs/providers/supported-integrations).

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

<ParamsDetails
  parameters={[{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"path","name":"id","required":true}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing a provider specification resource","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","description":"Name of the provider specification"},"slug":{"type":"string","description":"Unique slug for the provider specification"},"icon":{"type":"string","description":"Icon for the provider specification"},"description":{"type":"string","description":"Description of the provider specification"},"visible_to":{"type":"array","items":{"type":"string"},"description":"List of NRNs this specification is visible to"},"schema":{"type":"object","description":"[JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification.\nThis schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations).\nIt can also include custom JSON Schema keywords such as:\n\n• **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value.\n\n• **secret** (boolean): Marks a property as secret, ensuring the property's value is never revealed.\n\n• **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI.\n"},"allow_dimensions":{"type":"boolean","description":"Flag to allow dimensions for this specification"},"default_dimensions":{"type":"object","description":"Default dimensions for the provider specification"},"tags":{"type":"array","description":"Tags associated with the providers","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}},"categories":{"type":"array","items":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"description":"IDs of associated categories"},"dependencies":{"type":"array","items":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"description":"IDs of associated dependencies"},"organization_id":{"type":"integer","nullable":true,"description":"Organization ID that owns this specification. NULL means global (nullplatform-managed)"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"}},"title":"ProviderSpecificationRead","description":"Object representing a provider specification resource","required":["id","name","slug","schema","allow_dimensions","created_at","updated_at"]}}}},"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>