Get current user

Get information about the current user. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/user

Query parameters

excludeProjectsboolean

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.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

admin:infra:disallowedEmailDomains:writeadmin:infra:featureFlags:readadmin:infra:featureFlags:writeadmin:infra:config:readadmin:infra:config:writeadmin:infra:migrations:readadmin:infra:migrations:writeadmin:metrics:readadmin:metrics:writeadmin:organizations:readadmin:organizations:writeadmin:organizations:members:writeadmin:projects:members:writeadmin:projects:readadmin:projects:writeadmin:trials:readadmin:trials:writeadmin:users:permissions:writeadmin:users:readadmin:users:writeadmin:jobs:readadmin:emails:verification:code:readprojects:limits:writeprojects:training:keras:writethirdpartyauth:readthirdpartyauth:writeusers:emails:readwhitelabels:readwhitelabels:write

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

email*string

activated*boolean

organizations*array of UserOrganization (object)

Organizations that the user is a member of. Only filled when requesting information about yourself.

id*integer

name*string

logostring

isDeveloperProfile*boolean

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

isAdmin*boolean

Whether the user is admin of this organization or not.

created*string (date-time)

When the organization was created.

Example: "2019-08-31T17:32:28Z"

trialId*nullable number

Unique identifier of the trial this organization belongs to, if any.

Example: 1

trialExpiredDate*nullable string (date-time)

Date when the trial expired, if any. A expired trial has a grace period of 30 days before it's associated organization is deleted.

Example: "2019-08-31T17:32:28Z"

trialUpgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account, if any.

Example: "2019-08-31T17:32:28Z"

entitlementLimits*EntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

userCount*integer

The total number of users that are a member of this organization.

adminCount*integer

The number of admin users for this organization.

privateProjectCount*integer

The number of private projects for this organization.

lastAccessedstring (date-time)

Last time this user accessed this organization.

projects*array of Project (object)

List of all projects. This returns all projects for the user (regardless of whitelabel)

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

Whether this is a public version of a project. A version is a snapshot of a project at a certain point in time, which can be used to periodically save the state of a project. Versions can be private (just for internal use and reference) or public, available to everyone. A public version can be cloned by anyone, restoring the state of the project at the time into a new, separate project.

allowsLivePublicAccess*boolean

Whether this project allows live, public access. Unlike a public version, a live public project is not fixed in time, and always includes the latest project changes. Similar to public versions, a live public project can be cloned by anyone, creating a new, separate project.

indPauseProcessingSamples*boolean

publicProjectListed*boolean

If the project allows public access, whether to list it the public projects overview response. If not listed, the project is still accessible via direct link. If the project does not allow public access, this field has no effect.

experiments*array of UserExperiment (object)

Experiments the user has access to. Enabling experiments can only be done through a JWT token.

type*string

title*string

helpstring

enabled*boolean

showToUser*boolean

evaluationboolean

Whether this is an ephemeral evaluation account.

ambassadorboolean

Whether this user is an ambassador.

whitelabelsarray of object

List of white labels the user is a member of

id*number

domain*string

name*string

ownerOrganizationId*number

isAdmin*boolean

Whether the user is an admin of the white label.

suspended*boolean

Whether the user is suspended.

notifications*array of string

List of notifications to show to the user.

itemsstring

subscriptionDowngradeDatestring (date-time)

The date at which the user's subscription will be downgraded due to cancellation.

subscriptionTerminationDatestring (date-time)

The date at which the user's subscription will be automatically terminated due to failed payments.

passwordConfigured*boolean

Whether the user has configured a password

projectsSortOrder*UserProjectsSortOrder (enum)

created-asccreated-descadded-ascadded-descname-ascname-desclast-accessed-desc

activeEnterpriseTrialEnterpriseTrial (object)

id*integer

Unique identifier of the trial.

userId*integer

ID of the user who created the trial.

organizationId*integer

ID of the organization created for the trial.

created*string (date-time)

Date when the trial was created. Trials start immediately on creation.

expirationDate*TrialExpirationDate (string (date-time))

Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully deleting the trial organization. This field is ignored if the trial is requested by a non-admin user, defaulting to 14 days trial.

Example: "2020-01-01T00:00:00Z"

notesTrialNotes (string)

Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.

Example: "This is a trial for the company's new project."

expiredDate*nullable string (date-time)

Date when the trial actually expired. This is set when the trial is expired by the system.

deletedDate*nullable string (date-time)

Date when the trial was deleted. This is set when the trial is fully deleted by the system.

upgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account.

hasEnterpriseFeaturesAccess*boolean

Whether the current user has access to enterprise features. This is true if the user is an enterprise user, or has an active enterprise trial.

timezonestring

Timezone for the user (or undefined if not specified).

lastAccessedProjects*object

Last 5 accessed projects. This only returns projects for the current whitelabel ID.

projects*array of object

id*integer

name*string

created*string (date-time)

lastAccessedstring (date-time)

hasMoreProjects*boolean

privatePersonalProjectsUsed*integer

Number of private projects created by the current user.

Request

Response

Get current user

Get information about the current user. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/user

Query parameters

excludeProjectsboolean

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.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

email*string

activated*boolean

organizations*array of UserOrganization (object)

Organizations that the user is a member of. Only filled when requesting information about yourself.

id*integer

name*string

logostring

isDeveloperProfile*boolean

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

isAdmin*boolean

Whether the user is admin of this organization or not.

created*string (date-time)

When the organization was created.

Example: "2019-08-31T17:32:28Z"

trialId*nullable number

Unique identifier of the trial this organization belongs to, if any.

Example: 1

trialExpiredDate*nullable string (date-time)

Date when the trial expired, if any. A expired trial has a grace period of 30 days before it's associated organization is deleted.

Example: "2019-08-31T17:32:28Z"

trialUpgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account, if any.

Example: "2019-08-31T17:32:28Z"

entitlementLimits*EntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

userCount*integer

The total number of users that are a member of this organization.

adminCount*integer

The number of admin users for this organization.

privateProjectCount*integer

The number of private projects for this organization.

lastAccessedstring (date-time)

Last time this user accessed this organization.

projects*array of Project (object)

List of all projects. This returns all projects for the user (regardless of whitelabel)

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

allowsLivePublicAccess*boolean

indPauseProcessingSamples*boolean

publicProjectListed*boolean

experiments*array of UserExperiment (object)

Experiments the user has access to. Enabling experiments can only be done through a JWT token.

type*string

title*string

helpstring

enabled*boolean

showToUser*boolean

evaluationboolean

Whether this is an ephemeral evaluation account.

ambassadorboolean

Whether this user is an ambassador.

whitelabelsarray of object

List of white labels the user is a member of

id*number

domain*string

name*string

ownerOrganizationId*number

isAdmin*boolean

Whether the user is an admin of the white label.

suspended*boolean

Whether the user is suspended.

notifications*array of string

List of notifications to show to the user.

itemsstring

subscriptionDowngradeDatestring (date-time)

The date at which the user's subscription will be downgraded due to cancellation.

subscriptionTerminationDatestring (date-time)

The date at which the user's subscription will be automatically terminated due to failed payments.

passwordConfigured*boolean

Whether the user has configured a password

projectsSortOrder*UserProjectsSortOrder (enum)

created-asccreated-descadded-ascadded-descname-ascname-desclast-accessed-desc

activeEnterpriseTrialEnterpriseTrial (object)

id*integer

Unique identifier of the trial.

userId*integer

ID of the user who created the trial.

organizationId*integer

ID of the organization created for the trial.

created*string (date-time)

Date when the trial was created. Trials start immediately on creation.

expirationDate*TrialExpirationDate (string (date-time))

Example: "2020-01-01T00:00:00Z"

notesTrialNotes (string)

Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.

Example: "This is a trial for the company's new project."

expiredDate*nullable string (date-time)

Date when the trial actually expired. This is set when the trial is expired by the system.

deletedDate*nullable string (date-time)

Date when the trial was deleted. This is set when the trial is fully deleted by the system.

upgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account.

hasEnterpriseFeaturesAccess*boolean

Whether the current user has access to enterprise features. This is true if the user is an enterprise user, or has an active enterprise trial.

timezonestring

Timezone for the user (or undefined if not specified).

lastAccessedProjects*object

Last 5 accessed projects. This only returns projects for the current whitelabel ID.

projects*array of object

id*integer

name*string

created*string (date-time)

lastAccessedstring (date-time)

hasMoreProjects*boolean

privatePersonalProjectsUsed*integer

Number of private projects created by the current user.

Request

Response

{
  "success": false,
  "error": "text",
  "id": 1,
  "username": "janjongboom",
  "name": "Jan Jongboom",
  "email": "text",
  "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
  "created": "2019-08-31T17:32:28Z",
  "lastSeen": "2019-08-31T17:32:28Z",
  "staffInfo": {
    "isStaff": false,
    "hasSudoRights": false,
    "companyName": "text"
  },
  "pending": false,
  "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
  "jobTitle": "Software Engineer",
  "permissions": [
    "admin:infra:disallowedEmailDomains:write"
  ],
  "companyName": "Edge Impulse Inc.",
  "activated": false,
  "mfaConfigured": false,
  "stripeCustomerId": "text",
  "hasPendingPayments": false,
  "tier": "free",
  "organizations": [
    {
      "id": 0,
      "name": "text",
      "logo": "text",
      "isDeveloperProfile": false,
      "whitelabelId": 0,
      "isAdmin": false,
      "created": "2019-08-31T17:32:28Z",
      "trialId": 1,
      "trialExpiredDate": "2019-08-31T17:32:28Z",
      "trialUpgradedDate": "2019-08-31T17:32:28Z",
      "entitlementLimits": {
        "totalStorage": 0,
        "computeTimePerYear": 0,
        "gpuComputeTimePerYear": 0,
        "numberOfProjects": 0,
        "numberOfUsers": 0
      },
      "userCount": 0,
      "adminCount": 0,
      "privateProjectCount": 0,
      "lastAccessed": "2024-12-30T17:02:42.213Z"
    }
  ],
  "projects": [
    {
      "id": 1,
      "name": "Water hammer detection",
      "description": "text",
      "created": "2019-07-21T17:32:28Z",
      "owner": "text",
      "lastAccessed": "2019-07-21T17:32:28Z",
      "lastModified": "2019-07-21T17:32:28Z",
      "lastModificationDetails": "Data sample added",
      "logo": "text",
      "ownerUserId": 0,
      "ownerOrganizationId": 0,
      "ownerAvatar": "text",
      "ownerIsDeveloperProfile": false,
      "developerProfileUserId": 0,
      "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": false,
            "hasSudoRights": false,
            "companyName": "text"
          },
          "pending": false,
          "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
          "jobTitle": "Software Engineer",
          "permissions": [
            "admin:infra:disallowedEmailDomains:write"
          ],
          "companyName": "Edge Impulse Inc.",
          "activated": false,
          "mfaConfigured": false,
          "stripeCustomerId": "text",
          "hasPendingPayments": false,
          "tier": "free",
          "isOwner": false
        }
      ],
      "labelingMethod": "single_label",
      "dataExplorerScreenshot": "text",
      "isEnterpriseProject": false,
      "whitelabelId": 0,
      "tags": [
        "FOMO",
        "beers"
      ],
      "category": "Image classification",
      "license": "text",
      "tier": "free",
      "hasPublicVersion": false,
      "isPublic": false,
      "allowsLivePublicAccess": false,
      "indPauseProcessingSamples": false,
      "publicProjectListed": false
    }
  ],
  "experiments": [
    {
      "type": "text",
      "title": "text",
      "help": "text",
      "enabled": false,
      "showToUser": false
    }
  ],
  "evaluation": false,
  "ambassador": false,
  "whitelabels": [
    {
      "id": 0,
      "domain": "text",
      "name": "text",
      "ownerOrganizationId": 0,
      "isAdmin": false
    }
  ],
  "suspended": false,
  "notifications": [
    "text"
  ],
  "subscriptionDowngradeDate": "2024-12-30T17:02:42.213Z",
  "subscriptionTerminationDate": "2024-12-30T17:02:42.213Z",
  "passwordConfigured": false,
  "projectsSortOrder": "created-asc",
  "activeEnterpriseTrial": {
    "id": 0,
    "userId": 0,
    "organizationId": 0,
    "created": "2024-12-30T17:02:42.213Z",
    "expirationDate": "2020-01-01T00:00:00Z",
    "notes": "This is a trial for the company's new project.",
    "expiredDate": "2024-12-30T17:02:42.213Z",
    "deletedDate": "2024-12-30T17:02:42.213Z",
    "upgradedDate": "2024-12-30T17:02:42.213Z"
  },
  "hasEnterpriseFeaturesAccess": false,
  "timezone": "text",
  "lastAccessedProjects": {
    "projects": [
      {
        "id": 0,
        "name": "text",
        "created": "2024-12-30T17:02:42.213Z",
        "lastAccessed": "2024-12-30T17:02:42.213Z"
      }
    ],
    "hasMoreProjects": false
  },
  "privatePersonalProjectsUsed": 0
}