Organization - Retrieve

GET /v2/organizations/{id}

Retrieve an Organization by its unique identifier.

cURL

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

Response 200 (application/json):

Response body

{
  "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"
}

Authorizations

• Header: api-key (string) — required Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account.

Path parameters

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

Response schema (200)

• 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

Related

• Documentation: https://api-reference.hyperswitch.io/introduction

• Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

• Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

Suggest edits / Raise issue

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

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