Organization - Retrieve

GET /organization/{id}

Retrieve an Organization by its unique identifier.

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/organization/{id} \
  --header 'api-key: <api-key>'

Authorizations

Header: api-key (string, required)

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

Path parameters

• id (string, required) — The unique identifier for the Organization

Response — 200 application/json

Example:

Response (200)

{
  "organization_id": "org_q98uSGAYbjEwqs0mJwnz",
  "modified_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "organization_name": "<string>",
  "organization_details": {},
  "metadata": {},
  "organization_type": "standard"
}

Response fields:

• organization_id (string, required) The unique identifier for the Organization Required string length: 1 - 64 Example: "org_q98uSGAYbjEwqs0mJwnz"

• modified_at (string<date-time>, required)

• created_at (string<date-time>, required)

• organization_name (string | null) Name of the Organization

• organization_details (object) Details about the organization

• metadata (object) Metadata is useful for storing additional, unstructured information on an object.

• organization_type (enum) Available options: standard, platform

---

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/organization/organization--retrieve.mdx

Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/organization/organization--retrieve

Related:

• Organization — Create: https://api-reference.hyperswitch.io/v1/organization/organization--create

• Organization — Update: https://api-reference.hyperswitch.io/v1/organization/organization--update