Get current user

PreviousGet user registration state NextUpdate current user

Last updated 10 months ago

Was this helpful?

Get current user

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

get

/api/user

Authorizations

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/user' \
  --header 'x-api-key: YOUR_API_KEY'

200

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