---
id: onboard-read-organisation-type
title: "Read organisation type"
description: "Returns an organisation type (a sector), for example the type of your organisation. The `sector` of [Read organisation](/docs/openid4vc-api/onboard-read-organisation) is the `type` of the organisation type. A platform admin of the installation manages the organisation types; each organisation can read them."
sidebar_label: "Read organisation type"
hide_title: true
hide_table_of_contents: true
api: eJztWF9v2zgS/yoDvpwNKLaT+Hb31KK4NMku3O1tiiZtDmiDihHHFjcSqSUpu77A3/0wpCRLsZOmi3s6bB9Si5wZzv/5kfdMoE2NLJ3UisXsPbrKKAtcgTYLrqTltANuXSIMOFhMnTbDCObaAH7lRZkjuAwDgZ7DWlemxzqCqwwhCYwJkXx6j1z0aG4GY6FTO9YlKimmy/SAl3Ks1a3mRhwY5OKgSz4Eaf2hCZ3qZdLXjsIjOIEy526uTQFcFFI1pFJZx/M8kBZc8QXa/TLsC0CeZv2NlCsgrYilGLGI6RKN35oJFrNacTLzosN2tS6RRazkhhfo0FgWf7p/4H/y1ezscYtYxCTRldxlLGKKF8hiRlszwSJm8I9KGhQsdqbCiNk0w4Kz+N6TsJhZZ6RasIjVsWMx+4Hj0e38x+lheiy4mOPt0Y//+OkID9lmc0MSbamVRUtCjiYT+m9X5b2Kplo5VI44eFnmMvXb498tsd3v6qZvf8fU9az4xPRDB95ErDTkbyeDUjsU8X1PgiTHuOB7WfBF8JT/9cHkJO/h+X35Uuzz33eH7TkOb1R5znEU+kcPhAEt18XaP/01V3ckc7P1xnea59meKLqLuUMFWJRu3T+6PZP8/qxDP7x/+z84lf51VvanDIX58dC0SdK4r+M91k2n+ryIZciFr/F7+pqGynl2SXQTGI3R5lQLSmD/+6zjp2+m75Z763GpHC7QdN00nUw2e8Q/2TlecwFSlZWDtqexRsivuP52iE/A4VcHqRZtZA3OK8tzcBl3IDRaUNpBmnG1QFhlqMK08Wx+0Y7gQuVrsLpouS1kfIkgXX9OJd24f7GVLVEJFEkEyRy5qwx+EdLy2xxFAtpAUlam1Ba/4FdpnU1GTSr1rfhN7ynAjIeBMjuLIfmZyxwFOA0LdDXxf7bEMbwMHfxVQqn7MHMO/8qc/9PM8cjopHKZNnU+JBCiTwinkNZKtYhIIKl+8m4Gd7j2n/oOFdGQiUueS7EvcY73D+sdOa2zeJ7rFbhMWkh5no/gRLXUK+kyXTmviU11ue3FDfah5K5RVE4m3GqxhuT+M6Mc+swi+Mz+hdbyBX5mm8QLT/59cMmVuNVfL8xiJlrrfQxpwhES1S5DAzbQPSi1jIewatXq0yjstaHj2zwOOjzM1KDMNSUIfwgXfRVXRqEAPQ/i63jvWj+vw9RVMPIrXNkVGi8saVI82Zc5XHlICQUWt2haiiSM8+7Er3eG34WzuFpfzD3o/PNNYhPt4jUnna/qCx92L8MHf+9I3243tvA0RWshzTC9a9dKGXl36Hldn7pyaDvbkGrjgVXXltqMOs3YzeamP/hDN5tOjrc0MfugeF2CKGplXnywaHxdqL+50BJQ6WqRQYnG16VW9gXbGfSbiFlMKyPd2vv5pJS+nfVxbEx3B1IuYo4v6BrAuvcEcnqBLtOELRboGzPB/ZiNl9PmVjRuMnXclTym0IzvwzTZMNLGLPffNM6w0BC2WcQqD10y50obj8cCC01XsJFcGK7cSGof976Ad0aLKvWp/4iYb0m4dHwh1eIxdhu2Hypys/XxJaV2GFaNp9vs5GGhvi+FIG1vTL2mu5Onl1gXYtNLZOgyj/Rqao1+vzQ4l18hCcpAAgO/xcGWPMVh/EBADDXhS17Kgztcv0pGcGqQOwTePVdwm/moQ6XowJM01ZVy8ArOcIk59SBS1dKFl9is48bZoFeiV/buS/KiLzF06DfXV+C73SDB9ZvRaJQM67Y5nRwmIzj3N9+2w4WGvB0AvkvTJwlWiMLG9SnNsJCulXecNNp5tToNO+jiRVpIUq3mchGmaJ3rib9w00QCXKJZh2ZQ+yKhougydYpke6Q2dxY0TfvGAd0xoh8fL94GaeFWV5QTOgah/ay0lCM788vbJh0MnhxbW58MR3ClwWCZ87QOegRpkwIKV+SoCCobMImjKSUwR4eN64iAxpfMcf/8atHKrt0DnlsNfO4IcDgbJPuCpgRCMYxqh3vf17bZznSlNKnTrDPYHgFL4SVoxfOcQHCTVRYGnRCO9comQ8oM/kRIVrzWlRp2GK7J9HDSqNI7XyBPnVxyRxow6tBSzXUDqXnq5yYWXFLrsVVZauP+uW03bceQv2yX+n2q2+L2DLyW0XeTfSih9kkM0toKKfwClZOERr1BFyWq2dn04+kMDkeTCJZo5HztH5/6BO/CfkZp0ZVS53zj+j2vdGHY8tQBt8AbytLopRRoRjBzUPvGwuz86me4PDug7vHxNILZ5cV4dn4Khz9NDo8P/g6F0CkMirO3Qy/0+vgUPp7C4M311bCrVcBG5x/OZnAdjiPq84ruIFzB68pKRbjgutVlLnO0UYuSzuRCOp5Tx2wtPXk3I0yQyxSV9SO/afglTzOEo9FkJ36r1WrE/fZIm8W45rXjt7PT898uzw+IZ7NFOf14Cp1WBSrXDBKatiH2R5Oj6eh45J91Sm1dwVVHn503UKifqET/DtWCu7+eZv/c02wNB+jeR5hJKopHFR6gAqz6xJZTesMNNhHaqhWjxS4ua58R4/rB9SZimbaORNzf33JLL0CbDS3/UaEh3HcTsSU3kvB9wGA11mfxnOcWnwj34H2Na4fwjNfFvVY2SEgRDFryvMLwWHVHQKl5NPYQuYZHpGHYPElTLF2Hbedmsemi1F/Or1jECEb3EdidR2D1D5K+V6WHYCyoQH87t40+y0uqvV9x/aolDzuPMrQAMFCTg242m81/AQKSteg=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read organisation type</h1>

<MethodEndpoint method={"get"} path={"/v4/onboard/platform/organisation/type/{typeId}"}></MethodEndpoint>



Returns an organisation type (a sector), for example the type of your organisation. The `sector` of [Read organisation](/docs/openid4vc-api/onboard-read-organisation) is the `type` of the organisation type. A platform admin of the installation manages the organisation types; each organisation can read them.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation type.","in":"path","name":"typeId","required":true,"schema":{"type":"string","example":"6ae2bf741c3dadfeb27982e1"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The organisation type.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisationType</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation type.","example":"6ae2bf741c3dadfeb27982e1"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the organisation type (the sector).","example":"Banking"}}></SchemaItem><SchemaItem collapsible={false} name={"imageId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the image of the organisation type. Often empty.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"imageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the image of the organisation type. Often empty.","example":""}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"organisationType\": {\n    \"id\": \"6ae2bf741c3dadfeb27982e1\",\n    \"type\": \"Banking\",\n    \"imageId\": \"\",\n    \"imageUrl\": \"\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"organisationType\": {\n    \"id\": \"6ae2bf741c3dadfeb27982e1\",\n    \"type\": \"Banking\",\n    \"imageId\": \"\",\n    \"imageUrl\": \"\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

No organisation type has the ID: `Failed to get organization type: <typeId>`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

The `Authorization` header is missing, or the API key or token is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The API key or token does not allow this call. An API key without the scope of the operation gets the older body `{"Code", "Message"}`. An `X-SandboxOrgId` header that names another sandbox organisation than the one of the API key gets `{"errorCode", "errorDescription"}`. When a platform admin has turned off the feature of the operation for the organisation, the answer has `errorKey` `feature_disabled` and the member `feature` (the name of the feature).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></TabItem><TabItem label={"Older error body"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"Code"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The HTTP status.","example":403}}></SchemaItem><SchemaItem collapsible={false} name={"Message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What went wrong.","example":"Unauthorized access;User doesn't have enough permissions;"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"Code\": 403,\n  \"Message\": \"Unauthorized access;User doesn't have enough permissions;\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>