White Label Admin - Get a white label project

White label admin only API to get project information.

GET /api/organizations/{organizationId}/whitelabel/projects/{projectId}

Try it

White Label Admin - Get a white label project

cURL

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

200

{
  "success": true,
  "project": {
    "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"
  },
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

projectId · integer · required

Project ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

project · object · required

Show child attributes

project. id · integer · required

Example:

1

project. name · string · required

Example:

"Water hammer detection"

project. description · string · required

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

Example:

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

project. owner · string · required

User or organization that owns the project

project. ownerIsDeveloperProfile · boolean · required

project. collaborators · object[] · required

Show child attributes

project.collaborators. id · integer · required

Example:

1

project.collaborators. username · string · required

Example:

"janjongboom"

project.collaborators. name · string · required

Example:

"Jan Jongboom"

project.collaborators. email · string · required

Example:

"[e-mail]"

project.collaborators. created · string<date-time> · required

Example:

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

project.collaborators. staffInfo · object · required

Show child attributes

project.collaborators.staffInfo. isStaff · boolean · required

project.collaborators.staffInfo. hasSudoRights · boolean · required

project.collaborators.staffInfo. companyName · string

project.collaborators. pending · boolean · required

project.collaborators. activated · boolean · required

Whether the user has activated their account or not.

project.collaborators. mfaConfigured · boolean · required

Whether the user has configured multi-factor authentication

project.collaborators. isOwner · boolean · required

project.collaborators. photo · string

Example:

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

project.collaborators. lastSeen · string<date-time>

Example:

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

project.collaborators. jobTitle · string

Example:

"Software Engineer"

project.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

project.collaborators. companyName · string

Example:

"Edge Impulse Inc."

project.collaborators. stripeCustomerId · string

Stripe customer ID, if any.

project.collaborators. hasPendingPayments · boolean

Whether the user has pending payments.

project.collaborators. tier · enum<string>

The user account tier.

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

project.collaborators. idps · string[]

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

project. labelingMethod · enum<string> · required

Available options: single_label, object_detection

project. metadata · object · required

Metadata about the project

project. isEnterpriseProject · boolean · required

Whether this is an enterprise project

project. whitelabelId · integer | null · required

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

project. 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

project. hasPublicVersion · boolean · required

Whether this project has been published or not.

project. 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.

project. 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.

project. indPauseProcessingSamples · boolean · required

project. 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.

project. lastAccessed · string<date-time>

Example:

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

project. lastModified · string<date-time>

Example:

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

project. lastModificationDetails · string

Details about the last modification

Example:

"Data sample added"

project. logo · string

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

project. ownerUserId · integer

project. ownerOrganizationId · integer

project. ownerAvatar · string

URL of the project owner avatar, if any.

project. developerProfileUserId · integer

User ID of the developer profile, if any.

project. dataExplorerScreenshot · string

project. whitelabelName · string

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

project. tags · string[]

List of project tags

Example:

["FOMO", "beers"]

project. category · enum<string>

Project category

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

project. license · enum<string>

Public project license, if any.

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

project. deletedDate · string<date-time>

project. fullDeletionDate · string<date-time>

project. scheduledFullDeletionDate · string<date-time>

error · string

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