Organization information

List all information about this organization.

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

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

organization*Organization (object)

id*integer

name*string

EdgeImpulse Inc.

logostring

Example: "https://usercdn.edgeimpulse.com/logos/1.jpg"

headerImgstring

Example: "https://usercdn.edgeimpulse.com/leaders/1.jpg"

showHeaderImgMask*boolean

users*array of OrganizationUser (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

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)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

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

itemsPermission (enum)

admin:infra:disallowedEmailDomains:writeadmin:infra:featureFlags:readadmin:infra:featureFlags:writeadmin:infra:config:readadmin:infra:config:writeadmin:infra:migrations:readadmin:infra:migrations:writeadmin:metrics:readadmin:metrics:writeadmin:organizations:readadmin:organizations:writeadmin:organizations:members:writeadmin:projects:members:writeadmin:projects:readadmin:projects:writeadmin:trials:readadmin:trials:writeadmin:users:permissions:writeadmin:users:readadmin:users:writeadmin:jobs:readadmin:emails:verification:code:readprojects:limits:writeprojects:training:keras:writethirdpartyauth:readthirdpartyauth:writeusers:emails:readwhitelabels:readwhitelabels:write

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

added*string (date-time)

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

role*OrganizationMemberRole (enum)

adminmemberguest

projectCount*integer

datasets*array of string

itemsstring

lastAccessToOrganizationstring (date-time)

Date when the user last accessed the organization data.

lastOrganizationProjectAccessedinteger

ID of the last project accessed by the user in the organization.

isDeveloperProfile*boolean

whitelabelId*nullable integer

Unique identifier of the white label this organization belongs to, if any.

projectsarray of Project (object)

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

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)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

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

itemsPermission (enum)

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

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

Whether this is a public version of a project. A version is a snapshot of a project at a certain point in time, which can be used to periodically save the state of a project. Versions can be private (just for internal use and reference) or public, available to everyone. A public version can be cloned by anyone, restoring the state of the project at the time into a new, separate project.

allowsLivePublicAccess*boolean

Whether this project allows live, public access. Unlike a public version, a live public project is not fixed in time, and always includes the latest project changes. Similar to public versions, a live public project can be cloned by anyone, creating a new, separate project.

indPauseProcessingSamples*boolean

publicProjectListed*boolean

If the project allows public access, whether to list it the public projects overview response. If not listed, the project is still accessible via direct link. If the project does not allow public access, this field has no effect.

trialId*nullable integer

Unique identifier of the trial this organization belongs to, if any.

trialExpiredDate*nullable string (date-time)

Date when the trial expired, if any. A expired trial has a grace period of 30 days before it's associated organization is deleted.

trialUpgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account, if any.

created*string (date-time)

Date when the organization was created.

contractStartDatenullable string (date-time)

Date when the current contract started, if any.

deletedDatestring (date-time)

The date in which the organization was deleted. If the organization is not deleted, this field is not set.

datasets*array of OrganizationDataset (object)

dataset*string

lastFileCreated*string (date-time)

totalFileSize*integer

totalFileCount*integer

totalItemCount*integer

totalItemCountChecklistOK*integer

totalItemCountChecklistFailed*integer

tags*array of string

itemsstring

categorystring

bucketOrganizationDatasetBucket (object)

id*integer

Bucket ID

bucket*string

path*string

Path in the bucket

fullBucketPathDescription*string

Full bucket path, incl. protocol (e.g. s3://bucket/path) - to be used in the UI

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" type.

type*OrganizationDatasetTypeEnum (enum)

clinicalfiles

bucketPathstring

Location of the dataset within the bucket

defaultComputeLimits*object

requestsCpu*number

requestsMemory*number

limitsCpu*number

limitsMemory*number

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

experiments*array of object

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

type*string

title*string

helpstring

enabled*boolean

showToUser*boolean

readmeobject

Present if a readme is set for this project

markdown*string

html*string

whitelabelIdinteger

cliLists*object

objectDetectionLastLayerOptions*array of object

label*string

value*ObjectDetectionLastLayer (enum)

mobilenet-ssdfomoyolov2-akidayolov5yolov5v5-drpaiyoloxyolov7tao-retinanettao-ssdtao-yolov3tao-yolov4

imageInputScalingOptions*array of object

label*string

value*ImageInputScaling (enum)

Normalization that is applied to images. If this is not set then 0..1 is used. "0..1" gives you non-normalized pixels between 0 and 1. "-1..1" gives you non-normalized pixels between -1 and 1. "0..255" gives you non-normalized pixels between 0 and 255. "-128..127" gives you non-normalized pixels between -128 and 127. "torch" first scales pixels between 0 and 1, then applies normalization using the ImageNet dataset (same as torchvision.transforms.Normalize()). "bgr-subtract-imagenet-mean" scales to 0..255, reorders pixels to BGR, and subtracts the ImageNet mean from each channel.

0..1-1..1-128..1270..255torchbgr-subtract-imagenet-mean

performance*object

jobLimitM*integer

Compute time limit per job in minutes (for non-transformation jobs).

Request

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": "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": 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-21T12:05:47.785Z"
      }
    ],
    "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": "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": 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-21T12:05:47.785Z",
    "trialUpgradedDate": "2024-11-21T12:05:47.785Z",
    "created": "2024-11-21T12:05:47.785Z",
    "contractStartDate": "2024-11-21T12:05:47.785Z",
    "deletedDate": "2024-11-21T12:05:47.785Z"
  },
  "datasets": [
    {
      "dataset": "text",
      "lastFileCreated": "2024-11-21T12:05:47.785Z",
      "tags": [
        "text"
      ],
      "category": "text",
      "bucket": {
        "bucket": "text",
        "path": "text",
        "fullBucketPathDescription": "text"
      },
      "type": "clinical",
      "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": {}
}