Get organizations

List all organizations that the current user is a member of. This function is only available through a JWT token.

GET /api/user/organizations

Get organizations

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/user/organizations \
  --header 'x-api-key: <api-key>'

import requests

url = "https://studio.edgeimpulse.com/v1/api/user/organizations"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://studio.edgeimpulse.com/v1/api/user/organizations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/user/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/user/organizations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/user/organizations")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/user/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "organizations": [
    {
      "id": 123,
      "name": "<string>",
      "showHeaderImgMask": true,
      "users": [
        {
          "id": 1,
          "username": "janjongboom",
          "name": "Jan Jongboom",
          "email": "[e-mail]",
          "created": "2019-08-31T17:32:28Z",
          "staffInfo": {
            "isStaff": true,
            "hasSudoRights": true,
            "companyName": "<string>"
          },
          "pending": true,
          "activated": true,
          "mfaConfigured": true,
          "added": "2019-08-31T17:32:28Z",
          "projectCount": 123,
          "datasets": [
            "<string>"
          ],
          "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
          "lastSeen": "2019-08-31T17:32:28Z",
          "jobTitle": "Software Engineer",
          "permissions": [],
          "companyName": "Edge Impulse Inc.",
          "stripeCustomerId": "<string>",
          "hasPendingPayments": true,
          "idps": [
            "<string>"
          ],
          "lastAccessToOrganization": "2023-11-07T05:31:56Z",
          "lastOrganizationProjectAccessed": 123
        }
      ],
      "isDeveloperProfile": true,
      "whitelabelId": 123,
      "trialId": 123,
      "trialExpiredDate": "2023-11-07T05:31:56Z",
      "trialUpgradedDate": "2023-11-07T05:31:56Z",
      "created": "2023-11-07T05:31:56Z",
      "logo": "https://usercdn.edgeimpulse.com/logos/1.jpg",
      "headerImg": "https://usercdn.edgeimpulse.com/leaders/1.jpg",
      "whitelabelName": "<string>",
      "projects": [
        {
          "id": 1,
          "name": "Water hammer detection",
          "description": "<string>",
          "created": "2019-07-21T17:32:28Z",
          "owner": "<string>",
          "ownerIsDeveloperProfile": true,
          "collaborators": [
            {
              "id": 1,
              "username": "janjongboom",
              "name": "Jan Jongboom",
              "email": "[e-mail]",
              "created": "2019-08-31T17:32:28Z",
              "staffInfo": {
                "isStaff": true,
                "hasSudoRights": true,
                "companyName": "<string>"
              },
              "pending": true,
              "activated": true,
              "mfaConfigured": true,
              "isOwner": true,
              "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
              "lastSeen": "2019-08-31T17:32:28Z",
              "jobTitle": "Software Engineer",
              "permissions": [],
              "companyName": "Edge Impulse Inc.",
              "stripeCustomerId": "<string>",
              "hasPendingPayments": true,
              "idps": [
                "<string>"
              ]
            }
          ],
          "metadata": {},
          "isEnterpriseProject": true,
          "whitelabelId": 123,
          "hasPublicVersion": true,
          "isPublic": true,
          "allowsLivePublicAccess": true,
          "indPauseProcessingSamples": true,
          "publicProjectListed": true,
          "lastAccessed": "2019-07-21T17:32:28Z",
          "lastModified": "2019-07-21T17:32:28Z",
          "lastModificationDetails": "Data sample added",
          "logo": "<string>",
          "ownerUserId": 123,
          "ownerOrganizationId": 123,
          "ownerAvatar": "<string>",
          "developerProfileUserId": 123,
          "dataExplorerScreenshot": "<string>",
          "whitelabelName": "<string>",
          "tags": [
            "FOMO",
            "beers"
          ],
          "deletedDate": "2023-11-07T05:31:56Z",
          "fullDeletionDate": "2023-11-07T05:31:56Z",
          "scheduledFullDeletionDate": "2023-11-07T05:31:56Z"
        }
      ],
      "contractStartDate": "2023-11-07T05:31:56Z",
      "deletedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

organizations · object[] · required

Array with organizations

Show child attributes

error · string

Optional error description (set if 'success' was false)