curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations \
--header 'x-api-key: <api-key>'
{
"success": true,
"error": "<string>",
"organizations": [
{
"id": 123,
"name": "<string>",
"logo": "https://usercdn.edgeimpulse.com/logos/1.jpg",
"headerImg": "https://usercdn.edgeimpulse.com/leaders/1.jpg",
"showHeaderImgMask": true,
"users": [
{
"id": 1,
"username": "janjongboom",
"name": "Jan Jongboom",
"email": "quijote@edgeimpulse.com",
"photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
"created": "2019-08-31T17:32:28Z",
"lastSeen": "2019-08-31T17:32:28Z",
"staffInfo": {
"isStaff": true,
"hasSudoRights": true,
"companyName": "<string>"
},
"pending": true,
"jobTitle": "Software Engineer",
"permissions": [
"admin:infra:disallowedEmailDomains:write"
],
"companyName": "Edge Impulse Inc.",
"activated": true,
"mfaConfigured": true,
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"idps": [
"<string>"
],
"added": "2019-08-31T17:32:28Z",
"role": "admin",
"projectCount": 123,
"datasets": [
"<string>"
],
"lastAccessToOrganization": "2023-11-07T05:31:56Z",
"lastOrganizationProjectAccessed": 123
}
],
"isDeveloperProfile": true,
"whitelabelId": 123,
"whitelabelName": "<string>",
"projects": [
{
"id": 1,
"name": "Water hammer detection",
"description": "<string>",
"created": "2019-07-21T17:32:28Z",
"owner": "<string>",
"lastAccessed": "2019-07-21T17:32:28Z",
"lastModified": "2019-07-21T17:32:28Z",
"lastModificationDetails": "Data sample added",
"logo": "<string>",
"ownerUserId": 123,
"ownerOrganizationId": 123,
"ownerAvatar": "<string>",
"ownerIsDeveloperProfile": true,
"developerProfileUserId": 123,
"collaborators": [
{
"id": 1,
"username": "janjongboom",
"name": "Jan Jongboom",
"email": "quijote@edgeimpulse.com",
"photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
"created": "2019-08-31T17:32:28Z",
"lastSeen": "2019-08-31T17:32:28Z",
"staffInfo": {
"isStaff": true,
"hasSudoRights": true,
"companyName": "<string>"
},
"pending": true,
"jobTitle": "Software Engineer",
"permissions": [
"admin:infra:disallowedEmailDomains:write"
],
"companyName": "Edge Impulse Inc.",
"activated": true,
"mfaConfigured": true,
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"idps": [
"<string>"
],
"isOwner": true
}
],
"labelingMethod": "single_label",
"metadata": {},
"dataExplorerScreenshot": "<string>",
"isEnterpriseProject": true,
"whitelabelId": 123,
"whitelabelName": "<string>",
"tags": [
"FOMO",
"beers"
],
"category": "Accelerometer",
"license": "Apache-2.0",
"tier": "free",
"hasPublicVersion": true,
"isPublic": true,
"allowsLivePublicAccess": true,
"indPauseProcessingSamples": true,
"publicProjectListed": true,
"deletedDate": "2023-11-07T05:31:56Z",
"fullDeletionDate": "2023-11-07T05:31:56Z",
"scheduledFullDeletionDate": "2023-11-07T05:31:56Z"
}
],
"trialId": 123,
"trialExpiredDate": "2023-11-07T05:31:56Z",
"trialUpgradedDate": "2023-11-07T05:31:56Z",
"created": "2023-11-07T05:31:56Z",
"contractStartDate": "2023-11-07T05:31:56Z",
"deletedDate": "2023-11-07T05:31:56Z"
}
]
}
Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations \
--header 'x-api-key: <api-key>'
{
"success": true,
"error": "<string>",
"organizations": [
{
"id": 123,
"name": "<string>",
"logo": "https://usercdn.edgeimpulse.com/logos/1.jpg",
"headerImg": "https://usercdn.edgeimpulse.com/leaders/1.jpg",
"showHeaderImgMask": true,
"users": [
{
"id": 1,
"username": "janjongboom",
"name": "Jan Jongboom",
"email": "quijote@edgeimpulse.com",
"photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
"created": "2019-08-31T17:32:28Z",
"lastSeen": "2019-08-31T17:32:28Z",
"staffInfo": {
"isStaff": true,
"hasSudoRights": true,
"companyName": "<string>"
},
"pending": true,
"jobTitle": "Software Engineer",
"permissions": [
"admin:infra:disallowedEmailDomains:write"
],
"companyName": "Edge Impulse Inc.",
"activated": true,
"mfaConfigured": true,
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"idps": [
"<string>"
],
"added": "2019-08-31T17:32:28Z",
"role": "admin",
"projectCount": 123,
"datasets": [
"<string>"
],
"lastAccessToOrganization": "2023-11-07T05:31:56Z",
"lastOrganizationProjectAccessed": 123
}
],
"isDeveloperProfile": true,
"whitelabelId": 123,
"whitelabelName": "<string>",
"projects": [
{
"id": 1,
"name": "Water hammer detection",
"description": "<string>",
"created": "2019-07-21T17:32:28Z",
"owner": "<string>",
"lastAccessed": "2019-07-21T17:32:28Z",
"lastModified": "2019-07-21T17:32:28Z",
"lastModificationDetails": "Data sample added",
"logo": "<string>",
"ownerUserId": 123,
"ownerOrganizationId": 123,
"ownerAvatar": "<string>",
"ownerIsDeveloperProfile": true,
"developerProfileUserId": 123,
"collaborators": [
{
"id": 1,
"username": "janjongboom",
"name": "Jan Jongboom",
"email": "quijote@edgeimpulse.com",
"photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
"created": "2019-08-31T17:32:28Z",
"lastSeen": "2019-08-31T17:32:28Z",
"staffInfo": {
"isStaff": true,
"hasSudoRights": true,
"companyName": "<string>"
},
"pending": true,
"jobTitle": "Software Engineer",
"permissions": [
"admin:infra:disallowedEmailDomains:write"
],
"companyName": "Edge Impulse Inc.",
"activated": true,
"mfaConfigured": true,
"stripeCustomerId": "<string>",
"hasPendingPayments": true,
"tier": "free",
"idps": [
"<string>"
],
"isOwner": true
}
],
"labelingMethod": "single_label",
"metadata": {},
"dataExplorerScreenshot": "<string>",
"isEnterpriseProject": true,
"whitelabelId": 123,
"whitelabelName": "<string>",
"tags": [
"FOMO",
"beers"
],
"category": "Accelerometer",
"license": "Apache-2.0",
"tier": "free",
"hasPublicVersion": true,
"isPublic": true,
"allowsLivePublicAccess": true,
"indPauseProcessingSamples": true,
"publicProjectListed": true,
"deletedDate": "2023-11-07T05:31:56Z",
"fullDeletionDate": "2023-11-07T05:31:56Z",
"scheduledFullDeletionDate": "2023-11-07T05:31:56Z"
}
],
"trialId": 123,
"trialExpiredDate": "2023-11-07T05:31:56Z",
"trialUpgradedDate": "2023-11-07T05:31:56Z",
"created": "2023-11-07T05:31:56Z",
"contractStartDate": "2023-11-07T05:31:56Z",
"deletedDate": "2023-11-07T05:31:56Z"
}
]
}
OK
The response is of type object
.