1 of 45

User

Create user

Create evaluation user

Create Professional Tier user

Create enterprise trial user

Get user registration state

Get current user

Update current user

Delete current user

Get current user projects

Convert current evaluation user

Activate current user

Request activation code

Create developer profile

Start enterprise trial

List emails

Upload photo

Delete photo

Change password current user

Get organizations

Get buckets current user

Get user by third party activation code

Activate user by third party activation code

Accept Terms of Service

Dismiss a notification

Generate a new TOTP MFA key

Set TOTP MFA key

Remove TOTP MFA key

Upgrade subscription

Cancel subscription

Undo subscription cancellation

Get user billable compute metrics

Get user

Update user

Delete user

Activate user

Change password

Set password for SSO user

Get buckets

Send feedback

Send upgrade request

Get enterprise trials

Request reset password

Reset password

Verify reset password code

Create evaluation user

Creates an evaluation user and a new project, and redirects the user to the new project.

POSThttps://studio.edgeimpulse.com/v1/api-user-create-evaluate

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

token*string

JWT token, to be used to log in in the future through JWTAuthentication

redirectUrl*string

URL to redirect user to.

Request

Response

Create Professional Tier user

Create a new user for the Professional Plan and a new project. Note that the Professional plan will not be enabled until the payment is successful.

POSThttps://studio.edgeimpulse.com/v1/api-create-pro-user

Body

name*string

Your name

Example: "Jan Jongboom"

username*string

Username, minimum 4 and maximum 30 characters. May contain alphanumeric characters, hyphens, underscores and dots. Validated according to ^(?=.{4,30}$)(?![_.])(?!.*[_.]{2})[a-zA-Z0-9._-]+(?<![_.])$.

Example: "janjongboom"

email*string

E-mail address. Will need to be validated before the account will become active.

Example: "jan@edgeimpulse.com"

passwordstring

Password, minimum length 8 characters.

projectNamestring

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

privacyPolicy*boolean

Whether the user accepted the privacy policy

activationTokenstring

Activation token for users created via SSO

identityProviderstring

Unique identifier of the identity provider asserting the identity of this user

jobTitlestring

Job title of the user. Optional field

sessionIdstring

Session ID. Optional field

companyNamestring

ACME Inc.

utmParamsarray of UtmParameter (object)

List of UTM parameters.

Other propertiesany

ignoreEmailValidationboolean

If true, allows signup to proceed despite a potentially invalid email. Note that this will enforce email verification post-signup

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the professional user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the professional user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

redirectUrlstring

URL to redirect user to.

idinteger

User unique identifier

Request

Response

Create user

Create a new user and project

POSThttps://studio.edgeimpulse.com/v1/api-user-create

Body

name*string

Your name

Example: "Jan Jongboom"

username*string

Example: "janjongboom"

email*string

E-mail address. Will need to be validated before the account will become active.

Example: "jan@edgeimpulse.com"

passwordstring

Password, minimum length 8 characters.

projectNamestring

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

privacyPolicy*boolean

Whether the user accepted the privacy policy

activationTokenstring

Activation token for users created via SSO

identityProviderstring

Unique identifier of the identity provider asserting the identity of this user

jobTitlestring

Job title of the user. Optional field

sessionIdstring

Session ID. Optional field

companyNamestring

ACME Inc.

utmParamsarray of UtmParameter (object)

List of UTM parameters.

Other propertiesany

ignoreEmailValidationboolean

If true, allows signup to proceed despite a potentially invalid email. Note that this will enforce email verification post-signup

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

redirectUrlstring

URL to redirect user to.

idinteger

User unique identifier

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)

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 user registration state

Tells whether a user is registered and whether it needs to set its password.

GEThttps://studio.edgeimpulse.com/v1/api-user-need-to-set-password/{usernameOrEmail}

Path parameters

usernameOrEmail*string

Username or email

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

emailstring

User email

needPasswordboolean

Whether the user needs to set its password or not

whitelabelsarray of string

White label domains the user belongs to, if any

itemsstring

trialsarray of EnterpriseTrial (object)

Current or past enterprise trials.

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.

emailVerifiedboolean

Whether the user has verified its email address or not

Request

Response

Create enterprise trial user

Creates an enterprise trial user and a new trial organization, and redirects the user to the new organization.

POSThttps://studio.edgeimpulse.com/v1/api-user-create-enterprise-trial

Body

Trial request

emailstring

Email of the user requesting the trial. If this email is different to the one stored for the user requesting the trial, it will be used to replace the existing one.

Example: "fred@flintstones.org"

organizationNamestring

Name of the trial organization. All enterprise features are tied to an organization. This organization will be deleted after the trial ends. If no organization name is provided, the user's name will be used.

Example: "My Company"

expirationDateTrialExpirationDate (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."

useCasestring

Use case of the trial.

Example: "Industrial"

userHasMLModelsInProductionenum

Whether the user has ML models in production.

Example: "no"

yesnono, but we will soon

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

companySizestring

Size of the company requesting the trial. This is a range of number of employees.

Example: "1-10"

countrystring

Country of the company requesting the trial.

Example: "United States"

stateOrProvincestring

State or province of the company requesting the trial.

Example: "California"

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

name*string

Name of the user.

Example: "John Doe"

username*string

Example: "johndoe"

email*string

Email of the user. Only business email addresses are allowed. Emails with free domains like gmail.com or yahoo.com are not allowed.

Example: "jan@edgeimpulse.com"

privacyPolicy*boolean

Whether the user has accepted the terms of service and privacy policy.

passwordstring

Password of the user. Minimum length 8 characters.

jobTitlestring

Job title of the user.

Example: "TinyML engineer"

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

utmParamsarray of UtmParameter (object)

List of UTM parameters.

Other propertiesany

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

idnullable integer

Unique identifier of the created entity, if any.

userIdinteger

ID of the user created for the trial, if the user did not already exist.

redirectUrlstring

URL to redirect the user to in order to access the enterprise trial.

Request

Response

Get current user projects

Get projects for the current user. This returns all projects regardless of whitelabel. This function is only available through a JWT token.

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

projects*array of Project (object)

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

Request

Response

Update current user

Update user properties such as name. This function is only available through a JWT token.

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

Body

namestring

New full name

Example: "Jan Jongboom"

jobTitlestring

New job title

Example: "Embedded Software Engineer"

companyNamestring

New company name

Example: "Edge Impulse Inc."

experimentsarray of string

List of user experiments

itemsstring

projectsSortOrderUserProjectsSortOrder (enum)

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

timezonestring

User timezone.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete current user

Delete a user. This function is only available through a JWT token, and can only remove the current user.

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

Body

passwordstring

User's current password. Required if the user has a password set.

totpTokenstring

TOTP Token. Required if a user has multi-factor authentication with a TOTP token enabled. If a user has MFA enabled, but no totpToken is submitted; then an error starting with "ERR_TOTP_TOKEN IS REQUIRED" is returned. Use this to then prompt for an MFA token and re-try this request.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

List emails

Get a list of all emails sent by Edge Impulse to a user. This function is only available through a JWT token, and is not available for all users.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/emails

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

emails*array of object

List of emails

userIdinteger

projectIdinteger

from*string

to*string

created*string (date-time)

subject*string

bodyText*string

bodyHTML*string

sent*boolean

providerResponse*string

Request

Response

Start enterprise trial

Create an enterprise trial for the current user. Users can only go through a trial once.

POSThttps://studio.edgeimpulse.com/v1/api/user/trial

Body

emailstring

Email of the user requesting the trial. If this email is different to the one stored for the user requesting the trial, it will be used to replace the existing one.

Example: "fred@flintstones.org"

organizationNamestring

Example: "My Company"

expirationDateTrialExpirationDate (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."

useCasestring

Use case of the trial.

Example: "Industrial"

userHasMLModelsInProductionenum

Whether the user has ML models in production.

Example: "no"

yesnono, but we will soon

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

companySizestring

Size of the company requesting the trial. This is a range of number of employees.

Example: "1-10"

countrystring

Country of the company requesting the trial.

Example: "United States"

stateOrProvincestring

State or province of the company requesting the trial.

Example: "California"

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

idnullable integer

Unique identifier of the created entity, if any.

userIdinteger

ID of the user created for the trial, if the user did not already exist.

redirectUrlstring

URL to redirect the user to in order to access the enterprise trial.

Request

Response

Convert current evaluation user

Convert current evaluation user account to regular account.

POSThttps://studio.edgeimpulse.com/v1/api/user/convert

Body

name*string

Your name

Example: "Jan Jongboom"

username*string

Example: "janjongboom"

email*string

E-mail address. Will need to be validated before the account will become active.

Example: "jan@edgeimpulse.com"

password*string

Password, minimum length 8 characters.

projectNamestring

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

privacyPolicy*boolean

Whether the user accepted the privacy policy

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get organizations

List all organizations for a user. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/organizations

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

organizations*array of Organization (object)

Array with organizations

id*integer

name*string

EdgeImpulse Inc.

logostring

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

headerImgstring

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

showHeaderImgMask*boolean

users*array of OrganizationUser (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

added*string (date-time)

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

role*OrganizationMemberRole (enum)

adminmemberguest

projectCount*integer

datasets*array of string

itemsstring

lastAccessToOrganizationstring (date-time)

Date when the user last accessed the organization data.

lastOrganizationProjectAccessedinteger

ID of the last project accessed by the user in the organization.

isDeveloperProfile*boolean

whitelabelId*nullable integer

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

projectsarray of Project (object)

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

trialId*nullable integer

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

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.

trialUpgradedDate*nullable string (date-time)

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

created*string (date-time)

Date when the organization was created.

contractStartDatenullable string (date-time)

Date when the current contract started, if any.

deletedDatestring (date-time)

The date in which the organization was deleted. If the organization is not deleted, this field is not set.

Request

Response

Get buckets current user

List all organizational storage buckets that the current user has access to. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/buckets

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of object

id*integer

organizationId*integer

organizationName*string

bucket*string

S3 bucket

region*string

S3 region

whitelabelId*integer

The unique identifier of the white label this bucket belongs to, if any

Request

Response

Get user by third party activation code

Get information about a user through an activation code. This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/user/by-third-party-activation-code

Body

activationCode*string

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

Activate user by third party activation code

Activate a user that was created by a third party. This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/user/activate-by-third-party-activation-code

Body

activationCode*string

password*string

Password, minimum length 8 characters.

namestring

Your name

Example: "Jan Jongboom"

username*string

Example: "janjongboom"

privacyPolicyboolean

Whether the user accepted the privacy policy

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

tokenstring

JWT token, to be used to log in in the future through JWTAuthentication

redirectUrlstring

Redirect URL to follow to complete login

Request

Response

Set TOTP MFA key

Enable MFA on this account using an TOTP token. First create a new key via userGenerateNewTotpMfaKey.

POSThttps://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key

Body

key*string

Secret key obtained through userGenerateNewMfaKey.

totpToken*string

TOTP token that is valid for the key (to ensure the device is configured correctly)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

recoveryCodes*array of string

10 recovery codes, which can be used in case you've lost access to your MFA TOTP app. Recovery codes are single use. Once you've used a recovery code once, it can not be used again.

itemsstring

Request

Response

Generate a new TOTP MFA key

Creates a new MFA key, only allowed if the user has no MFA configured. TOTP tokens use SHA-1 algorithm.

POSThttps://studio.edgeimpulse.com/v1/api/user/mfa/totp/create-key

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

key*string

Secret key (use SHA-1).

url*string

URL that will be converted into a QR code that can be scanned.

Request

Response

Upgrade subscription

Upgrade the current subscription.

POSThttps://studio.edgeimpulse.com/v1/api/user/subscription/upgrade

Body

billingCycle*BillingCycle (enum)

Specifies the frequency at which the subscription fee is billed:

monthly: Billed once every month.
yearly: Billed once every year, often at a discounted rate compared to monthly billing.

monthlyyearly

successUrl*string

URL to redirect the user to after a successful checkout process.

cancelUrl*string

URL to redirect the user to after the checkout process is canceled.

Response

A redirect to the payment portal

Request

Get user billable compute metrics

Get billable compute metrics for a user. This function is only available to users with an active subscription.

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

metricsobject

computeMinutesCpu*number

Total compute of all user jobs, running on CPU, in the current billing period.

computeMinutesGpu*number

Total compute of all user jobs, running on GPU, in the current billing period.

computeMinutesTotal*number

Total compute of all user jobs in the current billing period, calculated as CPU + 3*GPU compute.

computeMinutesLimit*number

Overall compute limit for the current billing period.

computeResetDatestring (date-time)

The date at which the current compute billing period will reset.

Request

Response

Update user

Update user properties such as name. This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}

Path parameters

userId*integer

User ID

Body

namestring

New full name

Example: "Jan Jongboom"

jobTitlestring

New job title

Example: "Embedded Software Engineer"

companyNamestring

New company name

Example: "Edge Impulse Inc."

experimentsarray of string

List of user experiments

itemsstring

projectsSortOrderUserProjectsSortOrder (enum)

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

timezonestring

User timezone.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete user

Delete a user. This function is only available through a JWT token, and can only remove the current user.

DELETEhttps://studio.edgeimpulse.com/v1/api/users/{userId}

Path parameters

userId*integer

User ID

Body

passwordstring

User's current password. Required if the user has a password set.

totpTokenstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get user

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

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}

Path parameters

userId*integer

User ID

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

Activate user

Activate a user account (requires an activation code). This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}/activate

Path parameters

userId*integer

User ID

Body

code*string

Activation or verification code (sent via email)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get buckets

List all organizational storage buckets that a user has access to. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/buckets

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of object

id*integer

organizationId*integer

organizationName*string

bucket*string

S3 bucket

region*string

S3 region

whitelabelId*integer

The unique identifier of the white label this bucket belongs to, if any

Request

Response

Send feedback

Send feedback to Edge Impulse or get in touch with sales.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}/feedback

Path parameters

userId*integer

User ID

Body

type*enum

feedback

subject*string

The reason the user is contacting Edge Impulse Support.

body*string

The body of the message.

workEmailstring

The user's work email address. This is optional, if it's not provided, the registered email will be used.

companystring

The user's company. This is optional.

jobTitlestring

The user's job title. This is optional.

companySizestring

The user's company size. This is optional.

organizationIdnumber

The user's organization ID. This is optional.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Send upgrade request

Send an upgrade to Enterprise request to Edge Impulse.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}/upgrade

Path parameters

userId*integer

User ID

Body

reasonstring

Answer to the question: 'Why is this the right time for your team to invest in edge AI?'. This is optional.

useCasestring

Answer to the question: 'What best describes your use case?'. This is optional.

timelinestring

Answer to the question: 'What is your timeline for solving your problem?'. This is optional.

objectivestring

Answer to the question: 'What are you hoping to achieve with an extension?'. This is optional.

trialIdnumber

The user's trial ID. This is optional.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get enterprise trials

Get a list of all enterprise trials for a user. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/trials

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

trials*array of EnterpriseTrial (object)

Current or past enterprise trials.

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.

Request

Response

Generate a new TOTP MFA key

Creates a new MFA key, only allowed if the user has no MFA configured. TOTP tokens use SHA-1 algorithm.

POSThttps://studio.edgeimpulse.com/v1/api/user/mfa/totp/create-key

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

key*string

Secret key (use SHA-1).

url*string

URL that will be converted into a QR code that can be scanned.

Request

Response

Delete current user

Delete a user. This function is only available through a JWT token, and can only remove the current user.

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

Body

passwordstring

User's current password. Required if the user has a password set.

totpTokenstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Create evaluation user

Creates an evaluation user and a new project, and redirects the user to the new project.

POSThttps://studio.edgeimpulse.com/v1/api-user-create-evaluate

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

token*string

JWT token, to be used to log in in the future through JWTAuthentication

redirectUrl*string

URL to redirect user to.

Request

Response

Delete user

Delete a user. This function is only available through a JWT token, and can only remove the current user.

DELETEhttps://studio.edgeimpulse.com/v1/api/users/{userId}

Path parameters

userId*integer

User ID

Body

passwordstring

User's current password. Required if the user has a password set.

totpTokenstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Activate user

Activate a user account (requires an activation code). This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}/activate

Path parameters

userId*integer

User ID

Body

code*string

Activation or verification code (sent via email)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Upgrade subscription

Upgrade the current subscription.

POSThttps://studio.edgeimpulse.com/v1/api/user/subscription/upgrade

Body

billingCycle*BillingCycle (enum)

Specifies the frequency at which the subscription fee is billed:

monthly: Billed once every month.
yearly: Billed once every year, often at a discounted rate compared to monthly billing.

monthlyyearly

successUrl*string

URL to redirect the user to after a successful checkout process.

cancelUrl*string

URL to redirect the user to after the checkout process is canceled.

Response

A redirect to the payment portal

Request

Get buckets current user

List all organizational storage buckets that the current user has access to. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/buckets

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of object

id*integer

organizationId*integer

organizationName*string

bucket*string

S3 bucket

region*string

S3 region

whitelabelId*integer

The unique identifier of the white label this bucket belongs to, if any

Request

Response

Get user billable compute metrics

Get billable compute metrics for a user. This function is only available to users with an active subscription.

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

metricsobject

computeMinutesCpu*number

Total compute of all user jobs, running on CPU, in the current billing period.

computeMinutesGpu*number

Total compute of all user jobs, running on GPU, in the current billing period.

computeMinutesTotal*number

Total compute of all user jobs in the current billing period, calculated as CPU + 3*GPU compute.

computeMinutesLimit*number

Overall compute limit for the current billing period.

computeResetDatestring (date-time)

The date at which the current compute billing period will reset.

Request

Response

Set TOTP MFA key

Enable MFA on this account using an TOTP token. First create a new key via userGenerateNewTotpMfaKey.

POSThttps://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key

Body

key*string

Secret key obtained through userGenerateNewMfaKey.

totpToken*string

TOTP token that is valid for the key (to ensure the device is configured correctly)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

recoveryCodes*array of string

10 recovery codes, which can be used in case you've lost access to your MFA TOTP app. Recovery codes are single use. Once you've used a recovery code once, it can not be used again.

itemsstring

Request

Response

Convert current evaluation user

Convert current evaluation user account to regular account.

POSThttps://studio.edgeimpulse.com/v1/api/user/convert

Body

name*string

Your name

Example: "Jan Jongboom"

username*string

Example: "janjongboom"

email*string

E-mail address. Will need to be validated before the account will become active.

Example: "jan@edgeimpulse.com"

password*string

Password, minimum length 8 characters.

projectNamestring

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

privacyPolicy*boolean

Whether the user accepted the privacy policy

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get buckets

List all organizational storage buckets that a user has access to. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/buckets

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of object

id*integer

organizationId*integer

organizationName*string

bucket*string

S3 bucket

region*string

S3 region

whitelabelId*integer

The unique identifier of the white label this bucket belongs to, if any

Request

Response

Send upgrade request

Send an upgrade to Enterprise request to Edge Impulse.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}/upgrade

Path parameters

userId*integer

User ID

Body

reasonstring

Answer to the question: 'Why is this the right time for your team to invest in edge AI?'. This is optional.

useCasestring

Answer to the question: 'What best describes your use case?'. This is optional.

timelinestring

Answer to the question: 'What is your timeline for solving your problem?'. This is optional.

objectivestring

Answer to the question: 'What are you hoping to achieve with an extension?'. This is optional.

trialIdnumber

The user's trial ID. This is optional.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Activate user by third party activation code

Activate a user that was created by a third party. This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/user/activate-by-third-party-activation-code

Body

activationCode*string

password*string

Password, minimum length 8 characters.

namestring

Your name

Example: "Jan Jongboom"

username*string

Example: "janjongboom"

privacyPolicyboolean

Whether the user accepted the privacy policy

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

tokenstring

JWT token, to be used to log in in the future through JWTAuthentication

redirectUrlstring

Redirect URL to follow to complete login

Request

Response

Update current user

Update user properties such as name. This function is only available through a JWT token.

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

Body

namestring

New full name

Example: "Jan Jongboom"

jobTitlestring

New job title

Example: "Embedded Software Engineer"

companyNamestring

New company name

Example: "Edge Impulse Inc."

experimentsarray of string

List of user experiments

itemsstring

projectsSortOrderUserProjectsSortOrder (enum)

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

timezonestring

User timezone.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Update user

Update user properties such as name. This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}

Path parameters

userId*integer

User ID

Body

namestring

New full name

Example: "Jan Jongboom"

jobTitlestring

New job title

Example: "Embedded Software Engineer"

companyNamestring

New company name

Example: "Edge Impulse Inc."

experimentsarray of string

List of user experiments

itemsstring

projectsSortOrderUserProjectsSortOrder (enum)

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

timezonestring

User timezone.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

List emails

Get a list of all emails sent by Edge Impulse to a user. This function is only available through a JWT token, and is not available for all users.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/emails

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

emails*array of object

List of emails

userIdinteger

projectIdinteger

from*string

to*string

created*string (date-time)

subject*string

bodyText*string

bodyHTML*string

sent*boolean

providerResponse*string

Request

Response

Send feedback

Send feedback to Edge Impulse or get in touch with sales.

POSThttps://studio.edgeimpulse.com/v1/api/users/{userId}/feedback

Path parameters

userId*integer

User ID

Body

type*enum

feedback

subject*string

The reason the user is contacting Edge Impulse Support.

body*string

The body of the message.

workEmailstring

The user's work email address. This is optional, if it's not provided, the registered email will be used.

companystring

The user's company. This is optional.

jobTitlestring

The user's job title. This is optional.

companySizestring

The user's company size. This is optional.

organizationIdnumber

The user's organization ID. This is optional.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get enterprise trials

Get a list of all enterprise trials for a user. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/trials

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

trials*array of EnterpriseTrial (object)

Current or past enterprise trials.

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.

Request

Response

Create user

Create a new user and project

POSThttps://studio.edgeimpulse.com/v1/api-user-create

Body

name*string

Your name

Example: "Jan Jongboom"

username*string

Example: "janjongboom"

email*string

E-mail address. Will need to be validated before the account will become active.

Example: "jan@edgeimpulse.com"

passwordstring

Password, minimum length 8 characters.

projectNamestring

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

privacyPolicy*boolean

Whether the user accepted the privacy policy

activationTokenstring

Activation token for users created via SSO

identityProviderstring

Unique identifier of the identity provider asserting the identity of this user

jobTitlestring

Job title of the user. Optional field

sessionIdstring

Session ID. Optional field

companyNamestring

ACME Inc.

utmParamsarray of UtmParameter (object)

List of UTM parameters.

Other propertiesany

ignoreEmailValidationboolean

If true, allows signup to proceed despite a potentially invalid email. Note that this will enforce email verification post-signup

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

redirectUrlstring

URL to redirect user to.

idinteger

User unique identifier

Request

Response

Get user registration state

Tells whether a user is registered and whether it needs to set its password.

GEThttps://studio.edgeimpulse.com/v1/api-user-need-to-set-password/{usernameOrEmail}

Path parameters

usernameOrEmail*string

Username or email

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

emailstring

User email

needPasswordboolean

Whether the user needs to set its password or not

whitelabelsarray of string

White label domains the user belongs to, if any

itemsstring

trialsarray of EnterpriseTrial (object)

Current or past enterprise trials.

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.

emailVerifiedboolean

Whether the user has verified its email address or not

Request

Response

Create Professional Tier user

Create a new user for the Professional Plan and a new project. Note that the Professional plan will not be enabled until the payment is successful.

POSThttps://studio.edgeimpulse.com/v1/api-create-pro-user

Body

name*string

Your name

Example: "Jan Jongboom"

username*string

Example: "janjongboom"

email*string

E-mail address. Will need to be validated before the account will become active.

Example: "jan@edgeimpulse.com"

passwordstring

Password, minimum length 8 characters.

projectNamestring

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

privacyPolicy*boolean

Whether the user accepted the privacy policy

activationTokenstring

Activation token for users created via SSO

identityProviderstring

Unique identifier of the identity provider asserting the identity of this user

jobTitlestring

Job title of the user. Optional field

sessionIdstring

Session ID. Optional field

companyNamestring

ACME Inc.

utmParamsarray of UtmParameter (object)

List of UTM parameters.

Other propertiesany

ignoreEmailValidationboolean

If true, allows signup to proceed despite a potentially invalid email. Note that this will enforce email verification post-signup

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the professional user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the professional user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

redirectUrlstring

URL to redirect user to.

idinteger

User unique identifier

Request

Response

Create enterprise trial user

Creates an enterprise trial user and a new trial organization, and redirects the user to the new organization.

POSThttps://studio.edgeimpulse.com/v1/api-user-create-enterprise-trial

Body

Trial request

emailstring

Email of the user requesting the trial. If this email is different to the one stored for the user requesting the trial, it will be used to replace the existing one.

Example: "fred@flintstones.org"

organizationNamestring

Example: "My Company"

expirationDateTrialExpirationDate (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."

useCasestring

Use case of the trial.

Example: "Industrial"

userHasMLModelsInProductionenum

Whether the user has ML models in production.

Example: "no"

yesnono, but we will soon

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

companySizestring

Size of the company requesting the trial. This is a range of number of employees.

Example: "1-10"

countrystring

Country of the company requesting the trial.

Example: "United States"

stateOrProvincestring

State or province of the company requesting the trial.

Example: "California"

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

name*string

Name of the user.

Example: "John Doe"

username*string

Example: "johndoe"

email*string

Email of the user. Only business email addresses are allowed. Emails with free domains like gmail.com or yahoo.com are not allowed.

Example: "jan@edgeimpulse.com"

privacyPolicy*boolean

Whether the user has accepted the terms of service and privacy policy.

passwordstring

Password of the user. Minimum length 8 characters.

jobTitlestring

Job title of the user.

Example: "TinyML engineer"

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

utmParamsarray of UtmParameter (object)

List of UTM parameters.

Other propertiesany

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

idnullable integer

Unique identifier of the created entity, if any.

userIdinteger

ID of the user created for the trial, if the user did not already exist.

redirectUrlstring

URL to redirect the user to in order to access the enterprise trial.

Request

Response

Start enterprise trial

Create an enterprise trial for the current user. Users can only go through a trial once.

POSThttps://studio.edgeimpulse.com/v1/api/user/trial

Body

emailstring

Email of the user requesting the trial. If this email is different to the one stored for the user requesting the trial, it will be used to replace the existing one.

Example: "fred@flintstones.org"

organizationNamestring

Example: "My Company"

expirationDateTrialExpirationDate (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."

useCasestring

Use case of the trial.

Example: "Industrial"

userHasMLModelsInProductionenum

Whether the user has ML models in production.

Example: "no"

yesnono, but we will soon

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

companySizestring

Size of the company requesting the trial. This is a range of number of employees.

Example: "1-10"

countrystring

Country of the company requesting the trial.

Example: "United States"

stateOrProvincestring

State or province of the company requesting the trial.

Example: "California"

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

idnullable integer

Unique identifier of the created entity, if any.

userIdinteger

ID of the user created for the trial, if the user did not already exist.

redirectUrlstring

URL to redirect the user to in order to access the enterprise trial.

Request

Response

Get user

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

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}

Path parameters

userId*integer

User ID

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

Get current user projects

Get projects for the current user. This returns all projects regardless of whitelabel. This function is only available through a JWT token.

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

projects*array of Project (object)

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

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

Get user by third party activation code

Get information about a user through an activation code. This function is only available through a JWT token.

POSThttps://studio.edgeimpulse.com/v1/api/user/by-third-party-activation-code

Body

activationCode*string

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

Get organizations

List all organizations for a user. This function is only available through a JWT token.

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/organizations

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

organizations*array of Organization (object)

Array with organizations

id*integer

name*string

EdgeImpulse Inc.

logostring

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

headerImgstring

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

showHeaderImgMask*boolean

users*array of OrganizationUser (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

added*string (date-time)

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

role*OrganizationMemberRole (enum)

adminmemberguest

projectCount*integer

datasets*array of string

itemsstring

lastAccessToOrganizationstring (date-time)

Date when the user last accessed the organization data.

lastOrganizationProjectAccessedinteger

ID of the last project accessed by the user in the organization.

isDeveloperProfile*boolean

whitelabelId*nullable integer

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

projectsarray of Project (object)

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

trialId*nullable integer

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

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.

trialUpgradedDate*nullable string (date-time)

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

created*string (date-time)

Date when the organization was created.

contractStartDatenullable string (date-time)

Date when the current contract started, if any.

deletedDatestring (date-time)

The date in which the organization was deleted. If the organization is not deleted, this field is not set.

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": [
    {
      "name": "text",
      "logo": "text",
      "isDeveloperProfile": false,
      "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
      },
      "lastAccessed": "2024-11-23T07:56:07.419Z"
    }
  ],
  "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",
      "ownerAvatar": "text",
      "ownerIsDeveloperProfile": false,
      "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,
      "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-11-23T07:56:07.419Z",
  "subscriptionTerminationDate": "2024-11-23T07:56:07.419Z",
  "passwordConfigured": false,
  "projectsSortOrder": "created-asc",
  "activeEnterpriseTrial": {
    "created": "2024-11-23T07:56:07.419Z",
    "expirationDate": "2020-01-01T00:00:00Z",
    "notes": "This is a trial for the company's new project.",
    "expiredDate": "2024-11-23T07:56:07.419Z",
    "deletedDate": "2024-11-23T07:56:07.419Z",
    "upgradedDate": "2024-11-23T07:56:07.419Z"
  },
  "hasEnterpriseFeaturesAccess": false,
  "timezone": "text",
  "lastAccessedProjects": {
    "projects": [
      {
        "name": "text",
        "created": "2024-11-23T07:56:07.419Z",
        "lastAccessed": "2024-11-23T07:56:07.419Z"
      }
    ],
    "hasMoreProjects": false
  }
}

{
  "success": false,
  "error": "text",
  "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",
      "ownerAvatar": "text",
      "ownerIsDeveloperProfile": false,
      "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,
      "tags": [
        "FOMO",
        "beers"
      ],
      "category": "Image classification",
      "license": "text",
      "tier": "free",
      "hasPublicVersion": false,
      "isPublic": false,
      "allowsLivePublicAccess": false,
      "indPauseProcessingSamples": false,
      "publicProjectListed": false
    }
  ]
}

{
  "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": [
    {
      "name": "text",
      "logo": "text",
      "isDeveloperProfile": false,
      "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
      },
      "lastAccessed": "2024-11-23T07:56:07.419Z"
    }
  ],
  "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",
      "ownerAvatar": "text",
      "ownerIsDeveloperProfile": false,
      "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,
      "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-11-23T07:56:07.419Z",
  "subscriptionTerminationDate": "2024-11-23T07:56:07.419Z",
  "passwordConfigured": false,
  "projectsSortOrder": "created-asc",
  "activeEnterpriseTrial": {
    "created": "2024-11-23T07:56:07.419Z",
    "expirationDate": "2020-01-01T00:00:00Z",
    "notes": "This is a trial for the company's new project.",
    "expiredDate": "2024-11-23T07:56:07.419Z",
    "deletedDate": "2024-11-23T07:56:07.419Z",
    "upgradedDate": "2024-11-23T07:56:07.419Z"
  },
  "hasEnterpriseFeaturesAccess": false,
  "timezone": "text",
  "lastAccessedProjects": {
    "projects": [
      {
        "name": "text",
        "created": "2024-11-23T07:56:07.419Z",
        "lastAccessed": "2024-11-23T07:56:07.419Z"
      }
    ],
    "hasMoreProjects": false
  }
}

{
  "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": [
    {
      "name": "text",
      "logo": "text",
      "isDeveloperProfile": false,
      "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
      },
      "lastAccessed": "2024-11-23T07:56:07.419Z"
    }
  ],
  "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",
      "ownerAvatar": "text",
      "ownerIsDeveloperProfile": false,
      "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,
      "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-11-23T07:56:07.419Z",
  "subscriptionTerminationDate": "2024-11-23T07:56:07.419Z",
  "passwordConfigured": false,
  "projectsSortOrder": "created-asc",
  "activeEnterpriseTrial": {
    "created": "2024-11-23T07:56:07.419Z",
    "expirationDate": "2020-01-01T00:00:00Z",
    "notes": "This is a trial for the company's new project.",
    "expiredDate": "2024-11-23T07:56:07.419Z",
    "deletedDate": "2024-11-23T07:56:07.419Z",
    "upgradedDate": "2024-11-23T07:56:07.419Z"
  },
  "hasEnterpriseFeaturesAccess": false,
  "timezone": "text",
  "lastAccessedProjects": {
    "projects": [
      {
        "name": "text",
        "created": "2024-11-23T07:56:07.419Z",
        "lastAccessed": "2024-11-23T07:56:07.419Z"
      }
    ],
    "hasMoreProjects": false
  }
}

{
  "success": false,
  "error": "text",
  "organizations": [
    {
      "name": "text",
      "logo": "https://usercdn.edgeimpulse.com/logos/1.jpg",
      "headerImg": "https://usercdn.edgeimpulse.com/leaders/1.jpg",
      "showHeaderImgMask": false,
      "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": 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",
          "added": "2019-08-31T17:32:28Z",
          "role": "admin",
          "datasets": [
            "text"
          ],
          "lastAccessToOrganization": "2024-11-23T07:56:07.419Z"
        }
      ],
      "isDeveloperProfile": false,
      "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",
          "ownerAvatar": "text",
          "ownerIsDeveloperProfile": false,
          "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,
          "tags": [
            "FOMO",
            "beers"
          ],
          "category": "Image classification",
          "license": "text",
          "tier": "free",
          "hasPublicVersion": false,
          "isPublic": false,
          "allowsLivePublicAccess": false,
          "indPauseProcessingSamples": false,
          "publicProjectListed": false
        }
      ],
      "trialExpiredDate": "2024-11-23T07:56:07.419Z",
      "trialUpgradedDate": "2024-11-23T07:56:07.419Z",
      "created": "2024-11-23T07:56:07.419Z",
      "contractStartDate": "2024-11-23T07:56:07.419Z",
      "deletedDate": "2024-11-23T07:56:07.419Z"
    }
  ]
}