Get enterprise trials

Get a list of all enterprise trials for a user. This function is only available through a JWT token.

GET /api/users/{userId}/trials

Get enterprise trials

cURL

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

import requests

url = "https://studio.edgeimpulse.com/v1/api/users/{userId}/trials"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://studio.edgeimpulse.com/v1/api/users/{userId}/trials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/users/{userId}/trials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/users/{userId}/trials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/users/{userId}/trials")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/users/{userId}/trials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "trials": [
    {
      "id": 123,
      "userId": 123,
      "organizationId": 123,
      "created": "2023-11-07T05:31:56Z",
      "expirationDate": "2020-01-01T00:00:00Z",
      "expiredDate": "2023-11-07T05:31:56Z",
      "deletedDate": "2023-11-07T05:31:56Z",
      "upgradedDate": "2023-11-07T05:31:56Z",
      "notes": "This is a trial for the company's new project."
    }
  ],
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

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

trials · object[] · required

Current or past enterprise trials.

Show child attributes

error · string

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