curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId} \
--header 'x-api-key: <api-key>'{
"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:disallowedEmailDomains:read"
],
"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:disallowedEmailDomains:read"
],
"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"
},
"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
}List all information about this organization.
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId} \
--header 'x-api-key: <api-key>'{
"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:disallowedEmailDomains:read"
],
"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:disallowedEmailDomains:read"
],
"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"
},
"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
}Documentation Index
Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt
Use this file to discover all available pages before exploring further.
Organization ID
OK
Whether the operation succeeded
Show child attributes
Show child attributes
Show child attributes
Experiments that the organization has access to. Enabling experiments can only be done through a JWT token.
Show child attributes
Show child attributes
Show child attributes
Optional error description (set if 'success' was false)
Show child attributes
Present if a readme is set for this project
Show child attributes
Was this page helpful?