Get organizations

List all organizations for a user. This function is only available through a JWT token.

GET /api/users/{userId}/organizations

Try it

Get organizations

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/users/{userId}/organizations \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "organizations": [
    {
      "id": 123,
      "name": "<string>",
      "showHeaderImgMask": true,
      "users": [
        {
          "id": 1,
          "username": "janjongboom",
          "name": "Jan Jongboom",
          "email": "[e-mail]",
          "created": "2019-08-31T17:32:28Z",
          "staffInfo": {
            "isStaff": true,
            "hasSudoRights": true,
            "companyName": "<string>"
          },
          "pending": true,
          "activated": true,
          "mfaConfigured": true,
          "added": "2019-08-31T17:32:28Z",
          "role": "admin",
          "projectCount": 123,
          "datasets": [
            "<string>"
          ],
          "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
          "lastSeen": "2019-08-31T17:32:28Z",
          "jobTitle": "Software Engineer",
          "permissions": [
            "admin:infra:disallowedEmailDomains:read"
          ],
          "companyName": "Edge Impulse Inc.",
          "stripeCustomerId": "<string>",
          "hasPendingPayments": true,
          "tier": "free",
          "idps": [
            "<string>"
          ],
          "lastAccessToOrganization": "2023-11-07T05:31:56Z",
          "lastOrganizationProjectAccessed": 123
        }
      ],
      "isDeveloperProfile": true,
      "whitelabelId": 123,
      "trialId": 123,
      "trialExpiredDate": "2023-11-07T05:31:56Z",
      "trialUpgradedDate": "2023-11-07T05:31:56Z",
      "created": "2023-11-07T05:31:56Z",
      "logo": "https://usercdn.edgeimpulse.com/logos/1.jpg",
      "headerImg": "https://usercdn.edgeimpulse.com/leaders/1.jpg",
      "whitelabelName": "<string>",
      "projects": [
        {
          "id": 1,
          "name": "Water hammer detection",
          "description": "<string>",
          "created": "2019-07-21T17:32:28Z",
          "owner": "<string>",
          "ownerIsDeveloperProfile": true,
          "collaborators": [
            {
              "id": 1,
              "username": "janjongboom",
              "name": "Jan Jongboom",
              "email": "[e-mail]",
              "created": "2019-08-31T17:32:28Z",
              "staffInfo": {
                "isStaff": true,
                "hasSudoRights": true,
                "companyName": "<string>"
              },
              "pending": true,
              "activated": true,
              "mfaConfigured": true,
              "isOwner": true,
              "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
              "lastSeen": "2019-08-31T17:32:28Z",
              "jobTitle": "Software Engineer",
              "permissions": [
                "admin:infra:disallowedEmailDomains:read"
              ],
              "companyName": "Edge Impulse Inc.",
              "stripeCustomerId": "<string>",
              "hasPendingPayments": true,
              "tier": "free",
              "idps": [
                "<string>"
              ]
            }
          ],
          "labelingMethod": "single_label",
          "metadata": {},
          "isEnterpriseProject": true,
          "whitelabelId": 123,
          "tier": "free",
          "hasPublicVersion": true,
          "isPublic": true,
          "allowsLivePublicAccess": true,
          "indPauseProcessingSamples": true,
          "publicProjectListed": true,
          "lastAccessed": "2019-07-21T17:32:28Z",
          "lastModified": "2019-07-21T17:32:28Z",
          "lastModificationDetails": "Data sample added",
          "logo": "<string>",
          "ownerUserId": 123,
          "ownerOrganizationId": 123,
          "ownerAvatar": "<string>",
          "developerProfileUserId": 123,
          "dataExplorerScreenshot": "<string>",
          "whitelabelName": "<string>",
          "tags": [
            "FOMO",
            "beers"
          ],
          "category": "Accelerometer",
          "license": "Apache-2.0",
          "deletedDate": "2023-11-07T05:31:56Z",
          "fullDeletionDate": "2023-11-07T05:31:56Z",
          "scheduledFullDeletionDate": "2023-11-07T05:31:56Z"
        }
      ],
      "contractStartDate": "2023-11-07T05:31:56Z",
      "deletedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "error": "<string>"
}

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

organizations · object[] · required

Array with organizations

Show child attributes

organizations. id · integer · required

organizations. name · string · required

EdgeImpulse Inc.

organizations. showHeaderImgMask · boolean · required

organizations. users · object[] · required

Show child attributes

organizations.users. id · integer · required

Example:

1

organizations.users. username · string · required

Example:

"janjongboom"

organizations.users. name · string · required

Example:

"Jan Jongboom"

organizations.users. email · string · required

Example:

"[e-mail]"

organizations.users. created · string<date-time> · required

Example:

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

organizations.users. staffInfo · object · required

Show child attributes

organizations.users.staffInfo. isStaff · boolean · required

organizations.users.staffInfo. hasSudoRights · boolean · required

organizations.users.staffInfo. companyName · string

organizations.users. pending · boolean · required

organizations.users. activated · boolean · required

Whether the user has activated their account or not.

organizations.users. mfaConfigured · boolean · required

Whether the user has configured multi-factor authentication

organizations.users. added · string<date-time> · required

Example:

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

organizations.users. role · enum<string> · required

Available options: admin, member, guest

organizations.users. projectCount · integer · required

organizations.users. datasets · string[] · required

organizations.users. photo · string

Example:

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

organizations.users. lastSeen · string<date-time>

Example:

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

organizations.users. jobTitle · string

Example:

"Software Engineer"

organizations.users. permissions · enum<string>[]

List of permissions the user has

Available options: admin:infra:disallowedEmailDomains:read, admin:infra:disallowedEmailDomains:write, admin:infra:featureFlags:read, admin:infra:featureFlags:write, admin:infra:config:read, admin:infra:config:write, admin:infra:migrations:read, admin:infra:migrations:write, admin:metrics:read, admin:metrics:write, admin:oauth:read, admin:oauth:write, admin:organizations:read, admin:organizations:write, admin:organizations:members:write, admin:projects:members:write, admin:projects:read, admin:projects:write, admin:trashbin:write, admin:trials:read, admin:trials:write, admin:users:permissions:write, admin:users:read, admin:users:write, admin:jobs:read, admin:emails:verification:code:read, admin:sso:read, admin:sso:domainIdps:write, projects:limits:write, projects:training:keras:write, projects:data:versioning:write, thirdpartyauth:read, thirdpartyauth:write, users:emails:read, whitelabels:read, whitelabels:write, test:data:write

organizations.users. companyName · string

Example:

"Edge Impulse Inc."

organizations.users. stripeCustomerId · string

Stripe customer ID, if any.

organizations.users. hasPendingPayments · boolean

Whether the user has pending payments.

organizations.users. tier · enum<string>

The user account tier.

Available options: free, community-plus, professional, enterprise

organizations.users. idps · string[]

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

organizations.users. lastAccessToOrganization · string<date-time>

Date when the user last accessed the organization data.

organizations.users. lastOrganizationProjectAccessed · integer

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

organizations. isDeveloperProfile · boolean · required

organizations. whitelabelId · integer | null · required

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

organizations. trialId · integer | null · required

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

organizations. trialExpiredDate · string<date-time> | null · required

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

organizations. trialUpgradedDate · string<date-time> | null · required

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

organizations. created · string<date-time> · required

Date when the organization was created.

organizations. logo · string

Example:

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

organizations. headerImg · string

Example:

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

organizations. whitelabelName · string

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

organizations. projects · object[]

Show child attributes

organizations.projects. id · integer · required

Example:

1

organizations.projects. name · string · required

Example:

"Water hammer detection"

organizations.projects. description · string · required

organizations.projects. created · string<date-time> · required

Example:

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

organizations.projects. owner · string · required

User or organization that owns the project

organizations.projects. ownerIsDeveloperProfile · boolean · required

organizations.projects. collaborators · object[] · required

Show child attributes

organizations.projects.collaborators. id · integer · required

Example:

1

organizations.projects.collaborators. username · string · required

Example:

"janjongboom"

organizations.projects.collaborators. name · string · required

Example:

"Jan Jongboom"

organizations.projects.collaborators. email · string · required

Example:

"[e-mail]"

organizations.projects.collaborators. created · string<date-time> · required

Example:

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

organizations.projects.collaborators. staffInfo · object · required

Show child attributes

organizations.projects.collaborators.staffInfo. isStaff · boolean · required

organizations.projects.collaborators.staffInfo. hasSudoRights · boolean · required

organizations.projects.collaborators.staffInfo. companyName · string

organizations.projects.collaborators. pending · boolean · required

organizations.projects.collaborators. activated · boolean · required

Whether the user has activated their account or not.

organizations.projects.collaborators. mfaConfigured · boolean · required

Whether the user has configured multi-factor authentication

organizations.projects.collaborators. isOwner · boolean · required

organizations.projects.collaborators. photo · string

Example:

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

organizations.projects.collaborators. lastSeen · string<date-time>

Example:

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

organizations.projects.collaborators. jobTitle · string

Example:

"Software Engineer"

organizations.projects.collaborators. permissions · enum<string>[]

List of permissions the user has

Available options: admin:infra:disallowedEmailDomains:read, admin:infra:disallowedEmailDomains:write, admin:infra:featureFlags:read, admin:infra:featureFlags:write, admin:infra:config:read, admin:infra:config:write, admin:infra:migrations:read, admin:infra:migrations:write, admin:metrics:read, admin:metrics:write, admin:oauth:read, admin:oauth:write, admin:organizations:read, admin:organizations:write, admin:organizations:members:write, admin:projects:members:write, admin:projects:read, admin:projects:write, admin:trashbin:write, admin:trials:read, admin:trials:write, admin:users:permissions:write, admin:users:read, admin:users:write, admin:jobs:read, admin:emails:verification:code:read, admin:sso:read, admin:sso:domainIdps:write, projects:limits:write, projects:training:keras:write, projects:data:versioning:write, thirdpartyauth:read, thirdpartyauth:write, users:emails:read, whitelabels:read, whitelabels:write, test:data:write

organizations.projects.collaborators. companyName · string

Example:

"Edge Impulse Inc."

organizations.projects.collaborators. stripeCustomerId · string

Stripe customer ID, if any.

organizations.projects.collaborators. hasPendingPayments · boolean

Whether the user has pending payments.

organizations.projects.collaborators. tier · enum<string>

The user account tier.

Available options: free, community-plus, professional, enterprise

organizations.projects.collaborators. idps · string[]

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

organizations.projects. labelingMethod · enum<string> · required

Available options: single_label, object_detection

organizations.projects. metadata · object · required

Metadata about the project

organizations.projects. isEnterpriseProject · boolean · required

Whether this is an enterprise project

organizations.projects. whitelabelId · integer | null · required

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

organizations.projects. tier · enum<string> · required

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

Available options: free, community-plus, professional, enterprise

organizations.projects. hasPublicVersion · boolean · required

Whether this project has been published or not.

organizations.projects. isPublic · boolean · required

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.

organizations.projects. allowsLivePublicAccess · boolean · required

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.

organizations.projects. indPauseProcessingSamples · boolean · required

organizations.projects. publicProjectListed · boolean · required

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.

organizations.projects. lastAccessed · string<date-time>

Example:

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

organizations.projects. lastModified · string<date-time>

Example:

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

organizations.projects. lastModificationDetails · string

Details about the last modification

Example:

"Data sample added"

organizations.projects. logo · string

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

organizations.projects. ownerUserId · integer

organizations.projects. ownerOrganizationId · integer

organizations.projects. ownerAvatar · string

URL of the project owner avatar, if any.

organizations.projects. developerProfileUserId · integer

User ID of the developer profile, if any.

organizations.projects. dataExplorerScreenshot · string

organizations.projects. whitelabelName · string

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

organizations.projects. tags · string[]

List of project tags

Example:

["FOMO", "beers"]

organizations.projects. category · enum<string>

Project category

Available options: Accelerometer, Audio, Images, Keyword spotting, Object detection, Other

organizations.projects. license · enum<string>

Public project license, if any.

Available options: Apache-2.0, BSD-3-Clause, BSD-3-Clause-Clear

organizations.projects. deletedDate · string<date-time>

organizations.projects. fullDeletionDate · string<date-time>

organizations.projects. scheduledFullDeletionDate · string<date-time>

organizations. contractStartDate · string<date-time> | null

Date when the current contract started, if any.

organizations. deletedDate · string<date-time>

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

error · string

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