Organization information
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}"
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/organizations/{organizationId}', 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/organizations/{organizationId}",
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/organizations/{organizationId}"
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/organizations/{organizationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}")
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{
"success": true,
"organization": {
"id": 123,
"name": "<string>",
"showHeaderImgMask": true,
"users": [
{
"id": 1,
"username": "janjongboom",
"name": "Jan Jongboom",
"email": "quijote@edgeimpulse.com",
"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",
"role": "admin",
"projectCount": 123,
"datasets": [
"<string>"
],
"photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
"lastSeen": "2019-08-31T17:32:28Z",
"jobTitle": "Software Engineer",
"permissions": [
"admin:infra:datasetVersioning:queue:write"
],
"companyName": "Edge Impulse Inc.",
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"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": "quijote@edgeimpulse.com",
"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": [
"admin:infra:datasetVersioning:queue:write"
],
"companyName": "Edge Impulse Inc.",
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"idps": [
"<string>"
]
}
],
"labelingMethod": "single_label",
"metadata": {},
"isEnterpriseProject": true,
"whitelabelId": 123,
"tier": "free",
"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"
],
"category": "Accelerometer",
"license": "Apache-2.0",
"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",
"extensionSettings": {
"extensionsEnabled": true,
"extensionsAllowMembers": true,
"extensionsAllowLocalhost": true,
"extensionsAllowedDomains": [
"<string>"
],
"extensionsAllowedFirstPartyIds": [
123
],
"extensionsAllowAllFirstParty": true
}
},
"datasets": [
{
"dataset": "<string>",
"lastFileCreated": "2023-11-07T05:31:56Z",
"totalFileSize": 123,
"totalFileCount": 123,
"totalItemCount": 123,
"totalItemCountChecklistOK": 123,
"totalItemCountChecklistFailed": 123,
"tags": [
"<string>"
],
"type": "clinical",
"category": "<string>",
"bucket": {
"id": 123,
"bucket": "<string>",
"path": "<string>",
"fullBucketPathDescription": "<string>",
"dataItemNamingLevelsDeep": 123
},
"bucketPath": "<string>"
}
],
"defaultComputeLimits": {
"requestsCpu": 123,
"requestsMemory": 123,
"limitsCpu": 123,
"limitsMemory": 123
},
"experiments": [
{
"type": "<string>",
"title": "<string>",
"enabled": true,
"showToUser": true,
"help": "<string>"
}
],
"cliLists": {
"objectDetectionLastLayerOptions": [
{
"label": "<string>",
"value": "mobilenet-ssd"
}
],
"imageInputScalingOptions": [
{
"label": "<string>",
"value": "0..1"
}
]
},
"performance": {
"jobLimitM": 123
},
"error": "<string>",
"entitlementLimits": {
"totalStorage": 123,
"computeTimePerYear": 123,
"gpuComputeTimePerYear": 123,
"numberOfProjects": 123,
"numberOfUsers": 123
},
"readme": {
"markdown": "<string>",
"html": "<string>"
},
"whitelabelId": 123
}Organization information
List all information about this organization.
GET
/
api
/
organizations
/
{organizationId}
Organization information
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}"
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/organizations/{organizationId}', 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/organizations/{organizationId}",
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/organizations/{organizationId}"
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/organizations/{organizationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}")
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{
"success": true,
"organization": {
"id": 123,
"name": "<string>",
"showHeaderImgMask": true,
"users": [
{
"id": 1,
"username": "janjongboom",
"name": "Jan Jongboom",
"email": "quijote@edgeimpulse.com",
"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",
"role": "admin",
"projectCount": 123,
"datasets": [
"<string>"
],
"photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
"lastSeen": "2019-08-31T17:32:28Z",
"jobTitle": "Software Engineer",
"permissions": [
"admin:infra:datasetVersioning:queue:write"
],
"companyName": "Edge Impulse Inc.",
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"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": "quijote@edgeimpulse.com",
"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": [
"admin:infra:datasetVersioning:queue:write"
],
"companyName": "Edge Impulse Inc.",
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"idps": [
"<string>"
]
}
],
"labelingMethod": "single_label",
"metadata": {},
"isEnterpriseProject": true,
"whitelabelId": 123,
"tier": "free",
"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"
],
"category": "Accelerometer",
"license": "Apache-2.0",
"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",
"extensionSettings": {
"extensionsEnabled": true,
"extensionsAllowMembers": true,
"extensionsAllowLocalhost": true,
"extensionsAllowedDomains": [
"<string>"
],
"extensionsAllowedFirstPartyIds": [
123
],
"extensionsAllowAllFirstParty": true
}
},
"datasets": [
{
"dataset": "<string>",
"lastFileCreated": "2023-11-07T05:31:56Z",
"totalFileSize": 123,
"totalFileCount": 123,
"totalItemCount": 123,
"totalItemCountChecklistOK": 123,
"totalItemCountChecklistFailed": 123,
"tags": [
"<string>"
],
"type": "clinical",
"category": "<string>",
"bucket": {
"id": 123,
"bucket": "<string>",
"path": "<string>",
"fullBucketPathDescription": "<string>",
"dataItemNamingLevelsDeep": 123
},
"bucketPath": "<string>"
}
],
"defaultComputeLimits": {
"requestsCpu": 123,
"requestsMemory": 123,
"limitsCpu": 123,
"limitsMemory": 123
},
"experiments": [
{
"type": "<string>",
"title": "<string>",
"enabled": true,
"showToUser": true,
"help": "<string>"
}
],
"cliLists": {
"objectDetectionLastLayerOptions": [
{
"label": "<string>",
"value": "mobilenet-ssd"
}
],
"imageInputScalingOptions": [
{
"label": "<string>",
"value": "0..1"
}
]
},
"performance": {
"jobLimitM": 123
},
"error": "<string>",
"entitlementLimits": {
"totalStorage": 123,
"computeTimePerYear": 123,
"gpuComputeTimePerYear": 123,
"numberOfProjects": 123,
"numberOfUsers": 123
},
"readme": {
"markdown": "<string>",
"html": "<string>"
},
"whitelabelId": 123
}Authorizations
ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2
Response
200 - application/json
OK
Was this page helpful?