Get user

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

200

OK

Body

application/json

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: "[e-mail]"

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)

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

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.

projects*array of Project (object)

experiments*array of UserExperiment (object)

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

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

suspended*boolean

Whether the user is suspended.

notifications*array of string

List of notifications to show to the user.

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)

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.

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/users/{userId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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
      }
    }
  ],
  "projects": [
    {
      "id": 1,
      "name": "Water hammer detection",
      "description": "text",
      "created": "2019-07-21T17:32:28Z",
      "owner": "text",
      "lastAccessed": "2019-07-21T17:32:28Z",
      "logo": "text",
      "ownerAvatar": "text",
      "ownerIsDeveloperProfile": false,
      "collaborators": [
        {
          "id": 1,
          "username": "janjongboom",
          "name": "Jan Jongboom",
          "email": "[e-mail]",
          "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-07-04T18:18:47.547Z",
  "subscriptionTerminationDate": "2024-07-04T18:18:47.547Z",
  "passwordConfigured": false,
  "projectsSortOrder": "created-asc",
  "activeEnterpriseTrial": {
    "created": "2024-07-04T18:18:47.547Z",
    "expirationDate": "2020-01-01T00:00:00Z",
    "notes": "This is a trial for the company's new project.",
    "expiredDate": "2024-07-04T18:18:47.547Z",
    "deletedDate": "2024-07-04T18:18:47.547Z",
    "upgradedDate": "2024-07-04T18:18:47.547Z"
  },
  "hasEnterpriseFeaturesAccess": false
}