Organization routes

Get the Organization's basic information

This route will return to you the following:

the email, name, and ID of the organization.

Gets the organization's basic information

GET https://sandbox.oumla.com/api/v1/organizations

Headers

Name	Type	Description
x-api-key*	String	The API key generated from Oumla's dashboard

Sample code of the request:

TypeScript

async function getOrganizations() {
  const apiKey = "Your API Key";
  const url = "https://sandbox.oumla.com/api/v1/organizations";

  const response = await fetch(url, {
    method: "GET",
    headers: {
      "x-api-key": apiKey,
      "Content-Type": "application/json",
    },
  });

  const data = await response.json();
  console.log(data);
}

// Example usage
getOrganizations()

TypeScript (Axios)

import axios from "axios";

async function getOrganizations() {
  const apiKey = "Your API Key";
  const url = "https://sandbox.oumla.com/api/v1/organizations";

  try {
    const response = await axios.get(url, {
      headers: {
        "x-api-key": apiKey,
        "Content-Type": "application/json",
      },
    });

    console.log(response.data);
  } catch (error) {
    console.error("Error:", error);
  }
}

// Example usage
getOrganizations();

Python

import requests

response = requests.get('https://sandbox.oumla.com/api/v1/organizations', headers={
    'x-api-key': 'Your API Key'
})

if response.status_code == 200:
    print(response.json())
else:
    print(response.text)

The expected response:

200: OK

{
    "data": {
        "id": "89a625b9-4c5f-4130-8b56-afx8010f8103",
        "name": "test",
        "email": "[email protected]"
    },
    "success": true,
    "status": 200
}