Skip to content
English
  • There are no suggestions because the search field is empty.

Get organization by ID

GET /api/v1/organizations/{orgId} Select code sample Fetch cURL
const url = 'https://localhost:10001/api/v1/organizations/1';const options = {method: 'GET', headers: {Authorization: '
  
   '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}
  
curl --request GET \  --url https://localhost:10001/api/v1/organizations/1 \  --header 'Authorization: 
  
   '
  

Retrieve a specific organization by its ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ” orgId required integer

Organization ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization

Media type application/json object auth0Id

Deprecated: use IDPOrgID

string createdAt string description string displayName string id integer idpOrgId

Generic IDP organization ID

string idpProvider

IDP provider name (auth0, keycloak, etc)

string name string updatedAt string uuid string
Example generated
{  "auth0Id": "example",  "createdAt": "example",  "description": "example",  "displayName": "example",  "id": 1,  "idpOrgId": "example",  "idpProvider": "example",  "name": "example",  "updatedAt": "example",  "uuid": "example"}

400

Section titled “400 ”

Bad request - Invalid organization ID

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

403

Section titled “403 ”

Forbidden - No organization access

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

404

Section titled “404 ”

Organization not found

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

500

Section titled “500 ”

Internal server error

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}
Previous
Create organization
Next
Get organization by Auth ID