developer.sailpoint.com/docs/api/beta/list-connections.api.mdx

---
id: list-connections
sidebar_label: List connections for Governance Group
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2zYS/1cw7IcmGlEvv2LP3Nw4tpO649Q+Py5343paiIQkNCTAEqRlncf/++0uwJcetuNmek1OX2KJAhb73t+CQO49nYiUZ1Kr49Db8yJpsgOtlAjwkfHaXsbHxtu79t7rW5EqrgLB3qc6T4x30/ZCYYJUJjgWJl9OpGH7Z8csFVmeKsOQGtMjFlQUGTdGB5JnImRTmU0YZ/OUO7BqwlMei0ykuPa9p+ALLDDV6acxDgFe257ENROeTbx5Ro4PcdVsIpbSTsXvuUwFiJuluWh7JpiImHt79142S3AZk6VSjWGkuONxEuGjQbDbf9N7w3fe9Dd6uz3e68Onzf6gv9vfFUHAvYeH9r3l6PdcpDOY7HjWo5ER2QKLp/SYSZVpYnSURxHozeRRxuCHDrsyOY+iGTOJCORIFupqRTKWWYvBtISPpQJFwnwQbTwhOpaE6fysLoRg1//cIINcZFyFPA3ZgY4iawl2Vqr45tUkyxKz1+2G4lZE6BEdw2WUaGCvE+i4K0PV5YnsGkfHD0o6fmWq12ykUxbrVIBc8DEmv2qqfMQjI2qa7S3RP6wqxiKFeZaIfbQxgAexVDLOY5oXihEHWeHzSuWTshZ0/5MmpfGM+M0Kr0X1xfwO6bNbHuWCfiYSDIZs9b4apW79Aa06DVgipYq3Vus40Lla1PHxiLUwvFoMtDeV4NyJTvLIuqtgrX/5lzrjkX+As1votglkB8Emgocitb6OA1UeD+E7hLPzbGu4qc6jkA2FSzUQHXJUxgaok7Vs3LXYVKDmxgoUGIIBwYQSswEqT5gM4hwyUIasMBKEBVyxCb8V8BhMRqrC8TJOeJC1mfWFVIABY6FCWFjpDKPRCFy1RUT+RpK3kCfi1noTaQFHA9u5Kbj5KhxqRaIcah0Jrryao9DMlb5idEo5/bGkW3onqpj7RiDrUC68h3kfuwBqpVvkBm2JLlOIz8xMZfyO2UlD9BH1J+v6OxQY+PIdl6/J5PYZ+pHJkwRVErpMhCknivQUf4acH4VmD3wKlddmQSpQDW0wXUgFodVqlCga5Rc/Lprz4QYf2TAzqPhBr4d/mjo9wZINhecFNRtmZAJSAdDkSRLJgByr+5tBwveLFudpytE3ZCZiU3uuh7/BwggCUlR8Ji277vECxw6uAG92BAbjPHuIYx4lbn9dQRp949TRxnHtRaCgMGNee/sHB0cXF7+cnZ++Oz45gh/OT+nPxenhL2enJ8cH/6YvV+cHRwifKuMtTMxkRj+U0lkGLnFhCAQZLgudVSioUsx0IoOJLXmpGEFqRBWRtYRZBni2tt8EW4PdYLvXh08B3x7t9oL+Rn8DmbBB/RQbP+SQQSEAeMiHESR0mIR8zZutsfoR/NUzIfyQZ3zIjaD5/jQFX1nIA08xcFh9KxQyv3insXotJcB4cGm0BWR7LD6aISdd4oRICccqK1jtIBZcZT9kvoqsy6e8Dgd0HvO3IBDGnNtadi5upZhShT+dKvr7gSs+JtY/FtB5zu+WEqgLUE6s2DrMNAx5wFGby3LIAXgTVNKjNIWk5rPzWom2EJVWY0MdzjAJSgX1UYYvSSErojkUGSTrAx0+wz3fSSX8ccolciiI5QAmMqB4K0NMxFQqLcnCf2hc02lAE50+e8tD5rSJTkbCoDJTHnwCWsfPCNsrJWE+K6YwWRWHJcuKHcGH273dweZoe5PzwZvN/s7WcHfEN6BP2drdxdVjMDG4gVmSe5tLvxfgNjJgkQ7AIv8BhYCzg+6JAVr8+emaaDxD/5cglx1biun4ZZm4A8TF2duDM7a5wyKuxjk95+M5JSj/6gJRBjRRmGQsYAHJLeHTVI7l0kRRxNHh0bv9q5NLTNhH/7g6uoBPSGuhw91X4K0huqUmTDrRU+LYCTDlUNJFRPHeYS1HtQUCcWXqA6X9ZmYGlMkceIIZbvUlM+qk2SjVcSOUKG7uMvZKdkSnDQATngGIglSPGQmynLKoG8M9yfwTp8mWg9uvO2w/DCUKCTiY0KqB+TNEqjwMLXKyXSqEsiAQoPMMwawMRNMWlSqb1qgyykndKBgcwPnTfrIfZNAQk080orD0Fseisw/wbDXX5O6ypjRSKUJESGoB9dqBTlMslEOQTUK2d+mIkBokHlWMKzNWPVFSuvtgmbEZEvIZz80z4u4sgvTjk2jlD7fCBR8VHZuNyBqFmVxGcvsHNNmNKs1VBL7FkuvYXcfuOnafGbvzP567zqnAPgh9+ovQ50rxHPSbUvFcgD4peY/SrBhE8MYZss1AIQ4i/fjxEgL7k1A4Xtwl2MZ9QXxkS/kC8/ulPVzLXHTURemvbIEMkh6tBCPIRCLcI74rji1IJFVtLK72TqdDCQ6qlkBEyJopm+mccVBZmitF+zSmzUItjPo+czs0BF5tBsRVVejbBn2NJNdIcl2N1tXom6lGayS5jt117H6dsfsokiy5omhxOMnkcczTmfU09ztKyxkMqF6VlSFHpppHK0iMlRjLayIHbzjoD/ujnUBshnwz3N7YHQ2C7QHf2unv9Iebgx2vXuuvqzgug6wZUzV7WzuSigHE3QKOyxU4l8m0Dpvbfzm+vBlhWsPUU+Jm0Dmo9KbEjoPdRex4qTX7wNWsQEimgSFVpSPMaTA2xrFpMRYGcDaGvKjwFZ8EvtCVZCyACr5qsu98MXhRCqCbzvz9UQaiuLeTzsnKVaQKohw4pEwQaUTNGhxL4qu+EWI+oEAIdgzZ+QuiU2eiP4Tk2TlKfEJvuY/uAiEw0EvkvrVsf/cYmE8xR1xYA6/Y6LXdDlfgANAQ2JxV4s41Pl/j83WNX9f4b6PGr/H5OnbXsft1xu5n4HOHhlbjcxjwbHwOYzs9VmKpd3R+6s+G6RQqjgNyb6aDIE9pu7nA4KAEI+ChzGa0yBXg+gPryvsA2jEyZaj2ysO5e3hCwrvB80axABdEQcZ0BJYO6+553XKo6d7XzvQ+dIPG0WPbP1jJ8jSCmcWprHswOBj6ocMT2YE8iEc0ZkpP6WjWELS8JIHhSQMbrDiADoHZBTpkolRiFNiUScStwdyxNq88/fUo5eJwy0znkCSJTBvPDDmPpMfAYgLtyPeGRnfIAxfkA7mu0ujhj8tiCa2QZZn6Hl0NxjPgdE5EFOGmcpILxO529QVXqeoR9nuDhcVOcdiAvRU8hcbCvgJ59ePHy9dsjIiVMoY96SckthgQc2fgIpQR94vXATiJilR1LHq/8cIFI5CNIhCYuROYx04JP0GpOIfcTirFSYLSCc56/plA3pi34rzlz8pnhzItjtjhGCeiPZN6nRRy8ZpcL2Xiu4Kab6n5RA3PIza4sKq9DuwBngDSAJLgkSFtvXhxS8+v0cM+DJ4g1XkeUBOOj+ZrsqCw2ov5aNDzkV6Tj5/VRzof15zGbBZjZkKHjo9ZMNHaiL8zhq6DYXA9ziGKXswWHcrzKSL8Qa/Gkm+X9KUP4JL4O4HAUNaZ+BCLO2EbDbBPhTYkfyXLQsz/Suegf23ITI+voQbjyFAHn3HQdY5nXNDHBX2bA4zj35Y4dCyIbZSB8oB1gIPK/pQJHKO1vGdpLc3qRL5Lc7A0BMAqUTHJnv2yVyU494nRDzi6HANpGLF5+eIQT7o6WljnGsoqdhXmNbjIb6ShvM7pzfJb7mphyf2ryYsS71ebL6cqmn3pLL0ik/x18u7/KOOtM823mGkcWkZ3o2VdW1F38rcOry1uBho6Twz/wq8UqwTMoe2pLsPUCSURz9CrKaqDiRS0jZAIPIUciTZ6lo4pEqHjx/CHZpEIjekeQQosc2j8ZAT0aKO7WJlTwFhgiXbF7yYvT5AHE2hLRYd9hM5OBWAW7OrwqAb89pt27d0FWOYMDcsOC2MD6IrjXMFqGJd5zDi41BMeEUoT5DZxuc7AiqAJ+pWziihGV0MR6MS0SGNzOsIdamh+a4Z/Yi2wu3Hb09zeNnBXVypBzkXEixalCdufog3e5k9ElGBfCVkXAJiorfDh+HKBIhBTBuSC/l2n466bZLo4Fohge2TdZ6PT7/R8ahfgeaJNBp1wjTjd66jf6cDkuOSaxNzJ+nKb/kte7nTFBbuCboIbYshybrsU2yJeV1c9Uct7zYuf9S4R+o4JCItT7u9xGwXbpgd8bK8eYe8I6seYqO41rRTy/+tW5lI7fBK4sVHeWnV7F56HTerzFfmNXLF8REPF1dIXKmh9P/Lrux/5iDcUl2Bf6A3rm4yPare6Nlrp96ba6PrMJP/q3F2MfM0e/48ClnJUvN5Rszo7Baf1QvVwA8NtvBKHdoTd3K/NXXj93dg4fX+EoICvaMvch71r3Kr9LwuKH80=
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List connections for Governance Group' (list-connections)"
---

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"}>List connections for Governance Group</h1>

<MethodEndpoint method={"get"} path={"/workgroups/{workgroupId}/connections"}></MethodEndpoint>



This API returns list of connections associated with a Governance Group.

## 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={{"name":"workgroupId","in":"path","description":"ID of the Governance Group.","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":50,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":50,"default":50}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**","example":"name,-modified","required":false}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

List all connections associated with a Governance Group.

</div><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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>object</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Connected object to Governance Group

</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"ConnectedObjectType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `SOD_POLICY`, `SOURCE`]"} schema={{"description":"Connection Object type","type":"string","enum":["ACCESS_PROFILE","ROLE","SOD_POLICY","SOURCE"],"example":"ACCESS_PROFILE","title":"ConnectedObjectType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of Connected object","example":"Employee-database-read-write"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the Connected object.","example":"Collection of entitlements to read/write the employee database."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"connectionType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AccessRequestReviewer`, `Owner`, `ManagementWorkgroup`]"} schema={{"description":"Connection Type.","type":"string","enum":["AccessRequestReviewer","Owner","ManagementWorkgroup"],"example":"AccessRequestReviewer"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"object\": {\n      \"type\": \"ACCESS_PROFILE\",\n      \"id\": \"2c91808568c529c60168cca6f90c1313\",\n      \"name\": \"Employee-database-read-write\",\n      \"description\": \"Collection of entitlements to read/write the employee database.\"\n    },\n    \"connectionType\": \"AccessRequestReviewer\"\n  }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><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={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</div><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={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>