Get organizations

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

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

organizations*array of Organization (object)

Array with organizations

Request

JavaScriptCurlPython

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

Response

200

{
  "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": "[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",
          "added": "2019-08-31T17:32:28Z",
          "role": "admin",
          "datasets": [
            "text"
          ],
          "lastAccessToOrganization": "2024-11-21T09:01:29.281Z"
        }
      ],
      "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": "[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
        }
      ],
      "trialExpiredDate": "2024-11-21T09:01:29.281Z",
      "trialUpgradedDate": "2024-11-21T09:01:29.281Z",
      "created": "2024-11-21T09:01:29.281Z",
      "contractStartDate": "2024-11-21T09:01:29.281Z",
      "deletedDate": "2024-11-21T09:01:29.281Z"
    }
  ]
}