Returns information of the specified Organization.

Path Parameters

orgid string required

Unique identifier of the organization

Responses

Detailed information of the specified Organization

application/json

Schema

Example (from schema)

Example

Schema

id string

Unique identifier for the organization.

name string

Name of the organization.

createdAt date-time

The ISO 8601 date format of the time that the organization was created.

ownerId string

Unique identifier for the owner of the organization.

networks object[]

Array [

nwid string

Unique network identifier within the organization.

name string

Name of the network.

]

{
  "id": "dummy12345id",
  "name": "Awesome Egeland Test",
  "createdAt": "2024-03-11T21:18:00.524Z",
  "ownerId": "dummyOwner12345",
  "networks": [
    {
      "nwid": "dummyNetwork12345",
      "name": "Awesome Uncertain Butterfly"
    }
  ]
}

{
  "id": "dummy12345",
  "name": "Awesome Ztnet Organization",
  "createdAt": "2024-03-11T21:18:00.524Z",
  "ownerId": "dummyOwner12345",
  "networks": [
    {
      "nwid": "8056c2e21c000001",
      "name": "ztnetNetworkName1"
    },
    {
      "nwid": "8056c2e21c000001",
      "name": "ztnetNetworkName2"
    }
  ]
}

Unauthorized access, indicating that the request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

Schema

Example (from schema)

missingApiKey

invalidApiKey

Schema

error string

A message detailing the reason for the unauthorized status.

{
  "error": "Unauthorized: API key is missing or invalid."
}

API key is missing

{
  "error": "Unauthorized: API key is missing."
}

API key is invalid

{
  "error": "Unauthorized: API key is invalid."
}

Rate limit exceeded, indicating that the request was not accepted because the application has exceeded the rate limit for the API.

application/json

Schema

Example (from schema)

rateLimitExceededExample

Schema

error string

A message detailing the reason for exceeding the rate limit.

{
  "error": "Rate limit exceeded. Try again in X minutes."
}

Example response for rate limit exceeded

{
  "error": "Rate limit exceeded. Try again in 1 minute."
}

Internal Server Error, indicating that the server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Example (from schema)

internalServerErrorExample

Schema

error string

A message detailing the unexpected condition encountered by the server.

{
  "error": "Internal server error. Please try again later."
}

Example response for an internal server error

{
  "error": "Internal server error. Please try again later."
}

Returns information of the specified Organization.​

Returns information of the specified Organization.