GET
/
api
/
users
/
{userId}
Get user
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/users/{userId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "id": 1,
  "username": "janjongboom",
  "name": "Jan Jongboom",
  "email": "quijote@edgeimpulse.com",
  "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
  "created": "2019-08-31T17:32:28Z",
  "lastSeen": "2019-08-31T17:32:28Z",
  "staffInfo": {
    "isStaff": true,
    "hasSudoRights": true,
    "companyName": "<string>"
  },
  "pending": true,
  "jobTitle": "Software Engineer",
  "permissions": [
    "admin:infra:disallowedEmailDomains:read"
  ],
  "companyName": "Edge Impulse Inc.",
  "activated": true,
  "mfaConfigured": true,
  "stripeCustomerId": "<string>",
  "hasPendingPayments": true,
  "tier": "free",
  "idps": [
    "<string>"
  ],
  "organizations": [
    {
      "id": 123,
      "name": "<string>",
      "logo": "<string>",
      "isDeveloperProfile": true,
      "whitelabelId": 123,
      "isAdmin": true,
      "created": "2019-08-31T17:32:28Z",
      "trialId": 1,
      "trialExpiredDate": "2019-08-31T17:32:28Z",
      "trialUpgradedDate": "2019-08-31T17:32:28Z",
      "entitlementLimits": {
        "totalStorage": 123,
        "computeTimePerYear": 123,
        "gpuComputeTimePerYear": 123,
        "numberOfProjects": 123,
        "numberOfUsers": 123
      },
      "userCount": 123,
      "adminCount": 123,
      "privateProjectCount": 123,
      "lastAccessed": "2023-11-07T05:31:56Z",
      "publicProjectLicense": {
        "name": "<string>",
        "link": "<string>"
      }
    }
  ],
  "projects": [
    {
      "id": 1,
      "name": "Water hammer detection",
      "description": "<string>",
      "created": "2019-07-21T17:32:28Z",
      "owner": "<string>",
      "lastAccessed": "2019-07-21T17:32:28Z",
      "lastModified": "2019-07-21T17:32:28Z",
      "lastModificationDetails": "Data sample added",
      "logo": "<string>",
      "ownerUserId": 123,
      "ownerOrganizationId": 123,
      "ownerAvatar": "<string>",
      "ownerIsDeveloperProfile": true,
      "developerProfileUserId": 123,
      "collaborators": [
        {
          "id": 1,
          "username": "janjongboom",
          "name": "Jan Jongboom",
          "email": "quijote@edgeimpulse.com",
          "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
          "created": "2019-08-31T17:32:28Z",
          "lastSeen": "2019-08-31T17:32:28Z",
          "staffInfo": {
            "isStaff": true,
            "hasSudoRights": true,
            "companyName": "<string>"
          },
          "pending": true,
          "jobTitle": "Software Engineer",
          "permissions": [
            "admin:infra:disallowedEmailDomains:read"
          ],
          "companyName": "Edge Impulse Inc.",
          "activated": true,
          "mfaConfigured": true,
          "stripeCustomerId": "<string>",
          "hasPendingPayments": true,
          "tier": "free",
          "idps": [
            "<string>"
          ],
          "isOwner": true
        }
      ],
      "labelingMethod": "single_label",
      "metadata": {},
      "dataExplorerScreenshot": "<string>",
      "isEnterpriseProject": true,
      "whitelabelId": 123,
      "whitelabelName": "<string>",
      "tags": [
        "FOMO",
        "beers"
      ],
      "category": "Accelerometer",
      "license": "Apache-2.0",
      "tier": "free",
      "hasPublicVersion": true,
      "isPublic": true,
      "allowsLivePublicAccess": true,
      "indPauseProcessingSamples": true,
      "publicProjectListed": true,
      "deletedDate": "2023-11-07T05:31:56Z",
      "fullDeletionDate": "2023-11-07T05:31:56Z",
      "scheduledFullDeletionDate": "2023-11-07T05:31:56Z"
    }
  ],
  "experiments": [
    {
      "type": "<string>",
      "title": "<string>",
      "help": "<string>",
      "enabled": true,
      "showToUser": true
    }
  ],
  "evaluation": true,
  "ambassador": true,
  "whitelabels": [
    {
      "id": 123,
      "domain": "<string>",
      "name": "<string>",
      "ownerOrganizationId": 123,
      "isAdmin": true
    }
  ],
  "suspended": true,
  "suspensionReason": "<string>",
  "notifications": [
    "<string>"
  ],
  "subscriptionCancellationRequestDate": "2023-11-07T05:31:56Z",
  "subscriptionDowngradeDate": "2023-11-07T05:31:56Z",
  "subscriptionTerminationDate": "2023-11-07T05:31:56Z",
  "payAsYouGoSubscriptionPeriodStartDate": "2023-11-07T05:31:56Z",
  "payAsYouGoSubscriptionPeriodEndDate": "2023-11-07T05:31:56Z",
  "passwordConfigured": true,
  "projectsSortOrder": "created-asc",
  "activeEnterpriseTrial": {
    "id": 123,
    "userId": 123,
    "organizationId": 123,
    "created": "2023-11-07T05:31:56Z",
    "expirationDate": "2020-01-01T00:00:00Z",
    "notes": "This is a trial for the company's new project.",
    "expiredDate": "2023-11-07T05:31:56Z",
    "deletedDate": "2023-11-07T05:31:56Z",
    "upgradedDate": "2023-11-07T05:31:56Z"
  },
  "hasEnterpriseFeaturesAccess": true,
  "timezone": "<string>",
  "lastAccessedProjects": {
    "projects": [
      {
        "id": 123,
        "name": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "lastAccessed": "2023-11-07T05:31:56Z"
      }
    ],
    "hasMoreProjects": true
  },
  "privatePersonalProjectsUsed": 123,
  "lastAcceptedTermsOfService": {
    "version": "<string>",
    "acceptanceDate": "2023-11-07T05:31:56Z"
  },
  "eulas": [
    {
      "name": "syntiant",
      "description": "<string>",
      "latestVersion": "<string>",
      "acceptedVersion": "<string>",
      "link": "<string>",
      "userIsCompliant": true
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
userId
integer
required

User ID

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
id
integer
required
Example:

1

​
username
string
required
Example:

"janjongboom"

​
name
string
required
Example:

"Jan Jongboom"

​
email
string
required
Example:

"quijote@edgeimpulse.com"

​
created
string<date-time>
required
Example:

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

​
staffInfo
object
required
​
pending
boolean
required
​
activated
boolean
required

Whether the user has activated their account or not.

​
mfaConfigured
boolean
required

Whether the user has configured multi-factor authentication

​
tier
enum<string>
required

The user account tier.

Available options:
free,
community-plus,
professional,
enterprise
​
organizations
object[]
required

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

​
projects
object[]
required

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

​
experiments
object[]
required

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

​
suspended
boolean
required

Whether the user is suspended.

​
notifications
string[]
required

List of notifications to show to the user.

​
passwordConfigured
boolean
required

Whether the user has configured a password

​
projectsSortOrder
enum<string>
required

Default sort order on the projects list

Available options:
created-asc,
created-desc,
added-asc,
added-desc,
name-asc,
name-desc,
last-accessed-desc
​
hasEnterpriseFeaturesAccess
boolean
required

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.

​
lastAccessedProjects
object
required

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

​
privatePersonalProjectsUsed
integer
required

Number of private projects created by the current user.

​
eulas
object[]
required

List of all Vendor End-User License Agreements that the user has accepted, or could accept.

​
error
string

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

​
photo
string
Example:

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

​
lastSeen
string<date-time>
Example:

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

​
jobTitle
string
Example:

"Software Engineer"

​
permissions
enum<string>[]

List of permissions the user has

​
companyName
string
Example:

"Edge Impulse Inc."

​
stripeCustomerId
string

Stripe customer ID, if any.

​
hasPendingPayments
boolean

Whether the user has pending payments.

​
idps
string[]

List of identity providers (e.g. Google, GitHub) that the user has used to sign in with

​
evaluation
boolean

Whether this is an ephemeral evaluation account.

​
ambassador
boolean

Whether this user is an ambassador.

​
whitelabels
object[]

List of white labels the user is a member of

​
suspensionReason
string

Detailed explanation of why the user account was suspended. This could include violations of terms of service, suspicious activity, or administrative actions.

​
subscriptionCancellationRequestDate
string<date-time>

The date at which the user has requested to cancel their subscription.

​
subscriptionDowngradeDate
string<date-time>

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

​
subscriptionTerminationDate
string<date-time>

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

​
payAsYouGoSubscriptionPeriodStartDate
string<date-time>

The start date of the current pay-as-you-go subscription period.

​
payAsYouGoSubscriptionPeriodEndDate
string<date-time>

The end date of the current pay-as-you-go subscription period.

​
activeEnterpriseTrial
object

The ongoing free Enterprise trials that the user has created, if any.

​
timezone
string

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

​
lastAcceptedTermsOfService
object