EDedgeimpulse
Organizations

List active organizations

Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.

get/api/organizations

Request

  • Base URL
    https://studio.edgeimpulse.com/v1
  • Auth
    • API key in header x-api-key
    • or API key in cookie jwt
    • or API key in header x-jwt-token
    • or OAuth 2
      Authorization code/v1/oauth/authorize
      Client credentials
      Implicit/v1/oauth/authorize
      Password
      Token URL/v1/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

Example response

{
  "organizations": [
    {
      "logo": "https://usercdn.edgeimpulse.com/logos/1.jpg",
      "headerImg": "https://usercdn.edgeimpulse.com/leaders/1.jpg",
      "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",
          "jobTitle": "Software Engineer",
          "companyName": "Edge Impulse Inc.",
          "added": "2019-08-31T17:32:28Z"
        }
      ],
      "projects": [
        {
          "id": 1,
          "name": "Water hammer detection",
          "created": "2019-07-21T17:32:28Z",
          "lastAccessed": "2019-07-21T17:32:28Z",
          "lastModified": "2019-07-21T17:32:28Z",
          "lastModificationDetails": "Data sample added",
          "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",
              "jobTitle": "Software Engineer",
              "companyName": "Edge Impulse Inc."
            }
          ],
          "tags": [
            "FOMO",
            "beers"
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.