Organization information

Organization information

List all information about this organization.

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

Path parameters

organizationId*integer

Organization ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

organization*Organization (object)

datasets*array of OrganizationDataset (object)

defaultComputeLimits*object

entitlementLimitsEntitlementLimits (object)

experiments*array of object

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

readmeobject

Present if a readme is set for this project

whitelabelIdinteger

cliLists*object

performance*object

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "error": "text",
  "organization": {
    "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"
        ]
      }
    ],
    "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",
        "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-07-04T18:08:06.339Z",
    "trialUpgradedDate": "2024-07-04T18:08:06.339Z",
    "created": "2024-07-04T18:08:06.339Z",
    "contractStartDate": "2024-07-04T18:08:06.339Z",
    "deletedDate": "2024-07-04T18:08:06.339Z"
  },
  "datasets": [
    {
      "dataset": "text",
      "lastFileCreated": "2024-07-04T18:08:06.339Z",
      "tags": [
        "text"
      ],
      "category": "text",
      "bucket": {
        "bucket": "text",
        "path": "text",
        "fullBucketPathDescription": "text"
      },
      "type": "files",
      "bucketPath": "text"
    }
  ],
  "defaultComputeLimits": {
    "requestsCpu": 0,
    "requestsMemory": 0,
    "limitsCpu": 0,
    "limitsMemory": 0
  },
  "entitlementLimits": {
    "totalStorage": 0,
    "computeTimePerYear": 0,
    "gpuComputeTimePerYear": 0
  },
  "experiments": [
    {
      "type": "text",
      "title": "text",
      "help": "text",
      "enabled": false,
      "showToUser": false
    }
  ],
  "readme": {
    "markdown": "text",
    "html": "text"
  },
  "cliLists": {
    "objectDetectionLastLayerOptions": [
      {
        "label": "text",
        "value": "mobilenet-ssd"
      }
    ],
    "imageInputScalingOptions": [
      {
        "label": "text",
        "value": "0..1"
      }
    ]
  },
  "performance": {}
}