curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/user \
--header 'x-api-key: <api-key>'
{
"success": true,
"error": "<string>",
"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>"
],
"organizations": [
{
"id": 123,
"name": "<string>",
"logo": "<string>",
"isDeveloperProfile": true,
"whitelabelId": 123,
"isAdmin": true,
"created": "2019-08-31T17:32:28Z",
"trialId": 1,
"trialExpiredDate": "2019-08-31T17:32:28Z",
"trialUpgradedDate": "2019-08-31T17:32:28Z",
"entitlementLimits": {
"totalStorage": 123,
"computeTimePerYear": 123,
"gpuComputeTimePerYear": 123,
"numberOfProjects": 123,
"numberOfUsers": 123
},
"userCount": 123,
"adminCount": 123,
"privateProjectCount": 123,
"lastAccessed": "2023-11-07T05:31:56Z",
"publicProjectLicense": {
"name": "<string>",
"link": "<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"
}
],
"experiments": [
{
"type": "<string>",
"title": "<string>",
"help": "<string>",
"enabled": true,
"showToUser": true
}
],
"evaluation": true,
"ambassador": true,
"whitelabels": [
{
"id": 123,
"domain": "<string>",
"name": "<string>",
"ownerOrganizationId": 123,
"isAdmin": true
}
],
"suspended": true,
"suspensionReason": "<string>",
"notifications": [
"<string>"
],
"subscriptionCancellationRequestDate": "2023-11-07T05:31:56Z",
"subscriptionDowngradeDate": "2023-11-07T05:31:56Z",
"subscriptionTerminationDate": "2023-11-07T05:31:56Z",
"payAsYouGoSubscriptionPeriodStartDate": "2023-11-07T05:31:56Z",
"payAsYouGoSubscriptionPeriodEndDate": "2023-11-07T05:31:56Z",
"passwordConfigured": true,
"projectsSortOrder": "created-asc",
"activeEnterpriseTrial": {
"id": 123,
"userId": 123,
"organizationId": 123,
"created": "2023-11-07T05:31:56Z",
"expirationDate": "2020-01-01T00:00:00Z",
"notes": "This is a trial for the company's new project.",
"expiredDate": "2023-11-07T05:31:56Z",
"deletedDate": "2023-11-07T05:31:56Z",
"upgradedDate": "2023-11-07T05:31:56Z"
},
"hasEnterpriseFeaturesAccess": true,
"timezone": "<string>",
"lastAccessedProjects": {
"projects": [
{
"id": 123,
"name": "<string>",
"created": "2023-11-07T05:31:56Z",
"lastAccessed": "2023-11-07T05:31:56Z"
}
],
"hasMoreProjects": true
},
"privatePersonalProjectsUsed": 123,
"lastAcceptedTermsOfService": {
"version": "<string>",
"acceptanceDate": "2023-11-07T05:31:56Z"
},
"eulas": [
{
"name": "syntiant",
"description": "<string>",
"latestVersion": "<string>",
"acceptedVersion": "<string>",
"link": "<string>",
"userIsCompliant": true
}
]
}
Get information about the current user. This function is only available through a JWT token.
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/user \
--header 'x-api-key: <api-key>'
{
"success": true,
"error": "<string>",
"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>"
],
"organizations": [
{
"id": 123,
"name": "<string>",
"logo": "<string>",
"isDeveloperProfile": true,
"whitelabelId": 123,
"isAdmin": true,
"created": "2019-08-31T17:32:28Z",
"trialId": 1,
"trialExpiredDate": "2019-08-31T17:32:28Z",
"trialUpgradedDate": "2019-08-31T17:32:28Z",
"entitlementLimits": {
"totalStorage": 123,
"computeTimePerYear": 123,
"gpuComputeTimePerYear": 123,
"numberOfProjects": 123,
"numberOfUsers": 123
},
"userCount": 123,
"adminCount": 123,
"privateProjectCount": 123,
"lastAccessed": "2023-11-07T05:31:56Z",
"publicProjectLicense": {
"name": "<string>",
"link": "<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"
}
],
"experiments": [
{
"type": "<string>",
"title": "<string>",
"help": "<string>",
"enabled": true,
"showToUser": true
}
],
"evaluation": true,
"ambassador": true,
"whitelabels": [
{
"id": 123,
"domain": "<string>",
"name": "<string>",
"ownerOrganizationId": 123,
"isAdmin": true
}
],
"suspended": true,
"suspensionReason": "<string>",
"notifications": [
"<string>"
],
"subscriptionCancellationRequestDate": "2023-11-07T05:31:56Z",
"subscriptionDowngradeDate": "2023-11-07T05:31:56Z",
"subscriptionTerminationDate": "2023-11-07T05:31:56Z",
"payAsYouGoSubscriptionPeriodStartDate": "2023-11-07T05:31:56Z",
"payAsYouGoSubscriptionPeriodEndDate": "2023-11-07T05:31:56Z",
"passwordConfigured": true,
"projectsSortOrder": "created-asc",
"activeEnterpriseTrial": {
"id": 123,
"userId": 123,
"organizationId": 123,
"created": "2023-11-07T05:31:56Z",
"expirationDate": "2020-01-01T00:00:00Z",
"notes": "This is a trial for the company's new project.",
"expiredDate": "2023-11-07T05:31:56Z",
"deletedDate": "2023-11-07T05:31:56Z",
"upgradedDate": "2023-11-07T05:31:56Z"
},
"hasEnterpriseFeaturesAccess": true,
"timezone": "<string>",
"lastAccessedProjects": {
"projects": [
{
"id": 123,
"name": "<string>",
"created": "2023-11-07T05:31:56Z",
"lastAccessed": "2023-11-07T05:31:56Z"
}
],
"hasMoreProjects": true
},
"privatePersonalProjectsUsed": 123,
"lastAcceptedTermsOfService": {
"version": "<string>",
"acceptanceDate": "2023-11-07T05:31:56Z"
},
"eulas": [
{
"name": "syntiant",
"description": "<string>",
"latestVersion": "<string>",
"acceptedVersion": "<string>",
"link": "<string>",
"userIsCompliant": true
}
]
}
If set to "true", the "projects" field is left empty (will be faster if you call this function a lot). Use getCurrentUserProjects
to get the project list in a separate call.
OK
The response is of type object
.