List active projects
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/projects \
--header 'x-api-key: <api-key>'{
"success": true,
"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": [],
"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"
}
],
"error": "<string>"
}List active projects
Retrieve list of active projects. If authenticating using JWT token this lists all the projects the user has access to, if authenticating using an API key, this only lists that project.
GET
/
api
/
projects
List active projects
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/projects \
--header 'x-api-key: <api-key>'{
"success": true,
"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": [],
"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"
}
],
"error": "<string>"
}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.
Authorizations
ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2
Was this page helpful?
⌘I