NAV
Shell HTTP JavaScript Ruby Python PHP Java Go

HelpLightning API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Help Lightning RESTful API Specification

Base URLs:

License: Commercial

Authentication

Authentication

Endpoints for login, token exchange, and more

POST _v1_anonymous_auth

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/anonymous/auth \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/anonymous/auth HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "display_name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/anonymous/auth',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/anonymous/auth',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/anonymous/auth', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/anonymous/auth', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/anonymous/auth");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/anonymous/auth", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/anonymous/auth

Authenticate and get an anonymous user token

Body parameter

{
  "display_name": "string"
}

Parameters

Name In Type Required Description
body body object false none
» display_name body string false Display name of the anonymous user

Example responses

200 Response

{
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful Inline
401 Unauthorized Unauthorized, login credentials invalid errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» token string false none Anonymous user token

POST _v1_auth

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/auth \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/auth HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "email": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/auth',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/auth',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/auth', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/auth', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/auth");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/auth", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/auth

Exchanges login credentials for an authorization token

Body parameter

{
  "email": "string",
  "password": "string"
}

Parameters

Name In Type Required Description
body body object true none
» email body string true Email or username for user credentials
» password body string true User's password

Example responses

200 Response

{
  "refresh": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Login successful, authorization token is returned in the body refresh_tokenV1
401 Unauthorized Unauthorized, login credentials invalid errorV1
500 Internal Server Error Internal error errorV1

POST _v1_auth_exchange

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/auth/exchange \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/auth/exchange HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "refresh_token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/auth/exchange',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/auth/exchange',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/auth/exchange', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/auth/exchange', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/auth/exchange");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/auth/exchange", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/auth/exchange

Exchange a token for an alias with the login user. This is used for workspace migrations.

Body parameter

{
  "refresh_token": "string"
}

Parameters

Name In Type Required Description
body body object true none
» refresh_token body string true Refresh token for the user alias, from the user_authenticate method.

Example responses

200 Response

{
  "refresh": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Login successful, authorization token is returned in the body refresh_tokenV1
401 Unauthorized Unauthorized, login credentials invalid errorV1
500 Internal Server Error Internal error errorV1

POST _v1_auth_refresh

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/auth/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/auth/refresh HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "refresh_token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/auth/refresh',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/auth/refresh',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/auth/refresh', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/auth/refresh', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/auth/refresh");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/auth/refresh", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/auth/refresh

Regenerate a user token and refresh token

Body parameter

{
  "refresh_token": "string"
}

Parameters

Name In Type Required Description
body body object true none
» refresh_token body string true Refresh token for the user, from the user_authenticate method.

Example responses

200 Response

{
  "refresh": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Login successful, authorization token is returned in the body refresh_tokenV1
401 Unauthorized Unauthorized, login credentials invalid errorV1
500 Internal Server Error Internal error errorV1

POST _v1_enterprise_auth

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/auth \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/auth HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "email": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/auth',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/auth',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/auth', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/auth', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/auth");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/auth", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/auth

Exchanges login credentials for an enterprise authorization token

Body parameter

{
  "email": "string",
  "password": "string"
}

Parameters

Name In Type Required Description
body body object true none
» email body string true Email or username for user credentials
» password body string true User's password

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Login successful, enterprise authorization token is returned in the body string
401 Unauthorized Unauthorized, login credentials invalid errorV1
500 Internal Server Error Internal error errorV1

GET _v1_token_info

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/token/info \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/token/info HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/token/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/token/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/token/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/token/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/token/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/token/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/token/info

Gets information about some token

Parameters

Name In Type Required Description
token query string false Token to get information about

Example responses

200 Response

{
  "created_at": 0,
  "data": "string",
  "expires_at": 0,
  "issuer": "string",
  "permissions": [
    "string"
  ],
  "status": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about the token. token_info
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_token_validate

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/token/validate \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/token/validate HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/token/validate',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/token/validate',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/token/validate', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/token/validate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/token/validate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/token/validate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/token/validate

Validates a token

Parameters

Name In Type Required Description
token query string false Token to validate
resource_type query string false Resource type, such as user, enterprise, invitation
permission_category query string false Permission category to check. For example, owner, employee, etc.
permission_list query array[string] false Specific permissions to check. For example, view_contacts, view_account

Example responses

200 Response

{
  "created_at": 0,
  "data": "string",
  "expires_at": 0,
  "id": "string",
  "issuer": "string",
  "permissions": [
    "string"
  ],
  "status": "string",
  "type": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns ok. validated_token_info
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1r1_auth

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/auth \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/auth HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "email": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/auth',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/auth',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/auth', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/auth', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/auth");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/auth", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/auth

Exchanges login credentials for an authorization token

Body parameter

{
  "email": "string",
  "password": "string"
}

Parameters

Name In Type Required Description
body body object true none
» email body string true Email or username for user credentials
» password body string true User's password

Example responses

200 Response

{
  "refresh": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Login successful, authorization token is returned in the body refresh_tokenV1
400 Bad Request A generic error response errorV1R1

POST _v1r1_auth_from_url

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/auth/from_url \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/auth/from_url HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "link_url": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/auth/from_url',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/auth/from_url',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/auth/from_url', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/auth/from_url', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/auth/from_url");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/auth/from_url", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/auth/from_url

Uses a workbox invite url to get user authorization information

Body parameter

{
  "link_url": "string"
}

Parameters

Name In Type Required Description
body body object true none
» link_url body string false The workbox invite url

Example responses

200 Response

{
  "refresh": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Login successful, authorization and refresh token is returned in the body refresh_tokenV1
400 Bad Request A generic error response errorV1R1

Personal Access Tokens

Endpoints for using and managing Personal Access Tokens (PAT)

POST _v1r1_auth_pat

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/auth/pat \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/auth/pat HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/auth/pat',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/auth/pat',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/auth/pat', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/auth/pat', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/auth/pat");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/auth/pat", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/auth/pat

Exchanges personal access token for an authorization token

Body parameter

{
  "token": "string"
}

Parameters

Name In Type Required Description
body body object true none
» token body string true The encoded personal access token

Example responses

200 Response

{
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Login successful, authorization token is returned in the body tokenV1
400 Bad Request A generic error response errorV1R1

GET _v1r1_personal_access_token

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/personal_access_token \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/personal_access_token HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/personal_access_token',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/personal_access_token',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/personal_access_token', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/personal_access_token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/personal_access_token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/personal_access_token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/personal_access_token

Gets all of the personal access tokens owned by a user

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

[
  {
    "description": "string",
    "id": 0,
    "token": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns a list of personal access tokens Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [personal_access_token] false none none
» description string false none Human readable description of the token
» id integer(int32) false none Unique ID for the personal access token
» token string false none Encoded for the personal access token used for authentication

POST _v1r1_personal_access_token

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/personal_access_token \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/personal_access_token HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/personal_access_token',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/personal_access_token',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/personal_access_token', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/personal_access_token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/personal_access_token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/personal_access_token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/personal_access_token

Create a new personal access token for a user

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "description": "string",
  "id": 0,
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Personal access token created personal_access_token
400 Bad Request A generic error response errorV1R1

DELETE v1r1_personal_access_token{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/personal_access_token/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/personal_access_token/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/personal_access_token/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/personal_access_token/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/personal_access_token/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/personal_access_token/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/personal_access_token/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/personal_access_token/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/personal_access_token/{id}

Permanently removes a personal access token

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Personal Access Token ID

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, personal access token removed None
400 Bad Request A generic error response errorV1R1

GET v1r1_personal_access_token{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/personal_access_token/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/personal_access_token/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/personal_access_token/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/personal_access_token/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/personal_access_token/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/personal_access_token/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/personal_access_token/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/personal_access_token/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/personal_access_token/{id}

Gets a personal access token for a user by id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path string true Personal access token id

Example responses

200 Response

{
  "description": "string",
  "id": 0,
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns a personal access token personal_access_token
400 Bad Request A generic error response errorV1R1

Registration

Account Registration

POST _v1_register

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/register \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/register HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "invitation_token": "string",
  "user_info": {
    "email": "string",
    "name": "string",
    "password": "pa$$word"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/register',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/register',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/register', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/register', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/register");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/register", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/register

Registers a new personal account.

Body parameter

{
  "invitation_token": "string",
  "user_info": {
    "email": "string",
    "name": "string",
    "password": "pa$$word"
  }
}

Parameters

Name In Type Required Description
body body object true none
» invitation_token body string false Invitation token sent to an email.
» user_info body object true Information about the user creating the account
»» email body string true Email to tie to new user account. An email will be sent to this address with a confirmation token.
»» name body string true Full name of the user.
»» password body string(password) true Password for the account.

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Registration successful, and confirmation email is sent to the new user None
401 Unauthorized Unauthorized, invalid API key errorV1
500 Internal Server Error Internal error errorV1

POST _v1_register_confirm

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/register/confirm?confirmation_token=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/register/confirm?confirmation_token=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/register/confirm?confirmation_token=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/register/confirm',
  params: {
  'confirmation_token' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/register/confirm', params={
  'confirmation_token': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/register/confirm', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/register/confirm?confirmation_token=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/register/confirm", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/register/confirm

Confirms the registration of a new account.

Parameters

Name In Type Required Description
confirmation_token query string true none

Example responses

200 Response

{
  "message": "string",
  "status": "string"
}

Responses

Status Meaning Description Schema
200 OK Confirmation successful, account activated register_confirm
401 Unauthorized Unauthorized, invalid confirmation token errorV1
500 Internal Server Error Internal error errorV1

POST _v1_register_confirm_new_email

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/register/confirm_new_email?confirmation_token=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/register/confirm_new_email?confirmation_token=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/register/confirm_new_email?confirmation_token=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/register/confirm_new_email',
  params: {
  'confirmation_token' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/register/confirm_new_email', params={
  'confirmation_token': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/register/confirm_new_email', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/register/confirm_new_email?confirmation_token=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/register/confirm_new_email", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/register/confirm_new_email

Confirms the registration of a new email for an existing account.

Parameters

Name In Type Required Description
confirmation_token query string true none

Example responses

200 Response

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Confirmation successful, account's email address has changed user
401 Unauthorized Unauthorized, invalid confirmation token errorV1
500 Internal Server Error Internal error errorV1

POST _v1_register_resend_confirmation

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/register/resend_confirmation?email=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/register/resend_confirmation?email=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/register/resend_confirmation?email=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/register/resend_confirmation',
  params: {
  'email' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/register/resend_confirmation', params={
  'email': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/register/resend_confirmation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/register/resend_confirmation?email=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/register/resend_confirmation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/register/resend_confirmation

Resends the confirmation email for a new account.

Parameters

Name In Type Required Description
email query string true none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Confirmation email not sent None
401 Unauthorized Unauthorized, confirmation email not sent errorV1
500 Internal Server Error Internal error errorV1

POST _v1r1_register

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/register \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/register HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "invitation_token": "string",
  "user_info": {
    "email": "string",
    "location": "",
    "name": "string",
    "password": "pa$$word",
    "title": ""
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/register',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/register',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/register', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/register', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/register");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/register", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/register

Registers a new personal account.

Body parameter

{
  "invitation_token": "string",
  "user_info": {
    "email": "string",
    "location": "",
    "name": "string",
    "password": "pa$$word",
    "title": ""
  }
}

Parameters

Name In Type Required Description
body body object true none
» invitation_token body string false Invitation token sent to an email.
» user_info body object true Information about the user creating the account
»» email body string true Email to tie to new user account. An email will be sent to this address with a confirmation token.
»» location body string false Location of the contact
»» name body string true Full name of the user.
»» password body string(password) true Password for the account.
»» title body string false Title of the contact

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Registration successful, and confirmation email is sent to the new user None
400 Bad Request A generic error response errorV1R1

POST _v1r1_register_enterprise

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/register/enterprise \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/register/enterprise HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "contact_email": "string",
  "contact_name": "string",
  "enterprise_name": "string",
  "reseller_id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/register/enterprise',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/register/enterprise',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/register/enterprise', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/register/enterprise', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/register/enterprise");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/register/enterprise", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/register/enterprise

Create enterprise for non-authenticated users.

Body parameter

{
  "contact_email": "string",
  "contact_name": "string",
  "enterprise_name": "string",
  "reseller_id": "string"
}

Parameters

Name In Type Required Description
body body object true none
» contact_email body string true The email of contact.
» contact_name body string true The name of contact.
» enterprise_name body string true The name of enterprise.
» reseller_id body string true A reseller's id code.

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Registration successful. None
400 Bad Request A generic error response errorV1R1

User-Level: Calls & Communication

Calls at the User Level

GET _v1_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/calls

Get all the calls for a user.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
filter query string false none
page_size query integer false none
page query integer false none
order query string false none

Example responses

200 Response

[
  {
    "alt1_id": "string",
    "alt2_id": "string",
    "alt3_id": "string",
    "callDuration": 0,
    "dialderId": "string",
    "dialer": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "dialerName": "string",
    "extra_info": "string",
    "has_attachments": true,
    "intraEnterpriseCall": true,
    "owner_email": "string",
    "owner_id": "string",
    "owner_name": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "ratings": [
      {
        "participant_id": "string",
        "rating": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiver": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "receiverId": "string",
    "receiverName": "string",
    "recordingError": "string",
    "recordingStatus": "string",
    "recordingUrl": "string",
    "session": "string",
    "tags": [
      "string"
    ],
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": "string",
    "workbox_id": 0,
    "workbox_v2_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK A list of calls hermes_user_calls
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

GET _v1_calls_recent

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/calls/recent \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/calls/recent HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/calls/recent',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/calls/recent',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/calls/recent', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/calls/recent', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/calls/recent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/calls/recent", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/calls/recent

Returns recent call history.

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "contact": {
    "active": true,
    "anonymous": true,
    "available": true,
    "avatar": {
      "timestamp": "2019-08-24T14:15:22Z",
      "url": "string"
    },
    "email": "string",
    "enterprise_ids": [
      0
    ],
    "favorite": true,
    "id": "string",
    "is_group": true,
    "name": "string",
    "status": "string",
    "tags": [
      "string"
    ],
    "token": "string",
    "username": "string"
  },
  "contact_name": "string",
  "duration": 0,
  "has_attachments": true,
  "is_group": true,
  "outgoing": true,
  "participants": [
    {
      "email": "string",
      "enterpriseId": 0,
      "id": "string",
      "isAnonymous": true,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    }
  ],
  "ratings": [
    {
      "participant_id": "string",
      "rating": "string"
    }
  ],
  "reason": "string",
  "start_time": "2019-08-24T14:15:22Z",
  "status": true,
  "tags": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK Success recent_call
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_calls{call_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/calls/{call_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/calls/{call_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/calls/{call_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/calls/{call_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/calls/{call_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/calls/{call_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/calls/{call_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/calls/{call_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/calls/{call_id}

Get a specific call for a user.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true The call ID

Example responses

200 Response

{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "callDuration": 0,
  "dialderId": "string",
  "dialer": {
    "email": "string",
    "enterpriseId": "string",
    "id": "string",
    "name": "string",
    "username": "string"
  },
  "dialerName": "string",
  "extra_info": "string",
  "has_attachments": true,
  "intraEnterpriseCall": true,
  "owner_email": "string",
  "owner_id": "string",
  "owner_name": "string",
  "participants": [
    {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "isAnonymous": true,
      "name": "string",
      "username": "string"
    }
  ],
  "ratings": [
    {
      "participant_id": "string",
      "rating": "string"
    }
  ],
  "reasonCallEnded": "string",
  "receiver": {
    "email": "string",
    "enterpriseId": "string",
    "id": "string",
    "name": "string",
    "username": "string"
  },
  "receiverId": "string",
  "receiverName": "string",
  "recordingError": "string",
  "recordingStatus": "string",
  "recordingUrl": "string",
  "session": "string",
  "tags": [
    "string"
  ],
  "timeCallEnded": 0,
  "timeCallStarted": 0,
  "timestamp": "string",
  "workbox_id": 0,
  "workbox_v2_id": 0
}

Responses

Status Meaning Description Schema
200 OK The call hermes_call
401 Unauthorized Invalid token string
403 Forbidden Access Denied string
500 Internal Server Error Internal error errorV1

PUT v1_calls{call_id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/calls/{call_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/calls/{call_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "extra_info": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/calls/{call_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/calls/{call_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/calls/{call_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/calls/{call_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/calls/{call_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/calls/{call_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/calls/{call_id}

Update some properties of a call

Body parameter

{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "extra_info": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID
body body object true none
» alt1_id body string false Alternate ID 1 (limited to 512 characters)
» alt2_id body string false Alternate ID 2 (limited to 512 characters)
» alt3_id body string false Alternate ID 3 (limited to 512 characters)
» extra_info body string false Extra Blob of data

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_calls{call_id}_event_stream

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/calls/{call_id}/event_stream \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/calls/{call_id}/event_stream HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/calls/{call_id}/event_stream',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/calls/{call_id}/event_stream',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/calls/{call_id}/event_stream', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/calls/{call_id}/event_stream', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/calls/{call_id}/event_stream");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/calls/{call_id}/event_stream", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/calls/{call_id}/event_stream

Get the event stream for a specific call.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true The call ID

Example responses

200 Response

{
  "data": {
    "from": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "is_group": true,
    "reason": "string",
    "to": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "call_id": "string",
    "event_type": "call_started",
    "participant": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "message": "string",
    "creator": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "deleted": true,
    "id": 0,
    "mime_type": "string",
    "name": "string",
    "path": "string",
    "progress": 0,
    "signed_url": "string",
    "status": "unknown",
    "thumbnail": "string",
    "timestamp": 0,
    "type": "string"
  },
  "datetime": "2019-08-24T14:15:22Z",
  "type": "request"
}

Responses

Status Meaning Description Schema
200 OK The call events call_event_stream
401 Unauthorized Invalid token string
403 Forbidden Access Denied string
500 Internal Server Error Internal error errorV1

GET v1_calls{call_id}_events

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/calls/{call_id}/events \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/calls/{call_id}/events HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/calls/{call_id}/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/calls/{call_id}/events',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/calls/{call_id}/events', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/calls/{call_id}/events', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/calls/{call_id}/events");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/calls/{call_id}/events", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/calls/{call_id}/events

Get the events for a specific call.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true The call ID

Example responses

200 Response

{
  "call": {
    "callDuration": 0,
    "callId": "string",
    "dialerId": "string",
    "dialerName": "string",
    "galdrSession": "string",
    "intraEnterpriseCall": true,
    "lastEvaluatedTimestamp": 0,
    "openTokSession": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiverId": "string",
    "receiverName": "string",
    "recordingBucket": "string",
    "recordingError": "string",
    "recordingPath": "string",
    "recordingStatus": "string",
    "session": "string",
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": 0
  },
  "error": true,
  "stats": {
    "overallQuality": 0,
    "participantStats": [
      {
        "ended": {
          "appVersion": "string",
          "deviceType": "string",
          "deviceVersion": "string",
          "networkType": "string",
          "reason": "string",
          "timestamp": 0
        },
        "enterpriseId": "string",
        "id": "string",
        "isDialer": true,
        "name": "string",
        "network": {
          "avgQuality": 0,
          "avgResult": "string",
          "bandwidth": [
            {
              "audio": 0,
              "result": "string",
              "timestamp": 0,
              "video": 0
            }
          ],
          "packetLoss": [
            {
              "audio": 0,
              "result": "string",
              "timestamp": 0,
              "video": 0
            }
          ]
        },
        "started": {
          "appVersion": "string",
          "deviceType": "string",
          "deviceVersion": "string",
          "networkType": "string",
          "timestamp": 0
        }
      }
    ],
    "session": "string",
    "timestamp": 0
  }
}

Responses

Status Meaning Description Schema
200 OK The call events hermes_call_event
401 Unauthorized Invalid token string
403 Forbidden Access Denied string
500 Internal Server Error Internal error errorV1

GET _v1_on_call_groups

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/on_call_groups \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/on_call_groups HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/on_call_groups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/on_call_groups',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/on_call_groups', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/on_call_groups', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/on_call_groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/on_call_groups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/on_call_groups

List of on call groups visible to the user

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": "string",
      "description": "string",
      "enterprise_id": 0,
      "favorite": true,
      "id": 0,
      "name": "string",
      "on_call_group": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success on_call_groups
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_on_call_groups{group_id}_favorites

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/on_call_groups/{group_id}/favorites

Unfavorites an on call group

Parameters

Name In Type Required Description
authorization header string true A user authorization token
group_id path integer true On call group ID

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST v1_on_call_groups{group_id}_favorites

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/on_call_groups/{group_id}/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/on_call_groups/{group_id}/favorites

Favorites an on call group

Parameters

Name In Type Required Description
authorization header string true A user authorization token
group_id path integer true On call group ID

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_personal_room_invite

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/personal_room/invite \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/personal_room/invite HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "email": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/personal_room/invite',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/personal_room/invite',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/personal_room/invite', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/personal_room/invite', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/personal_room/invite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/personal_room/invite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/personal_room/invite

Invite someone to our personal room. Only certain enterprise users have a personal room.

Body parameter

{
  "email": "string",
  "name": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» email body string true The email of the person we are inviting
» name body string true The name of the person we are inviting

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_session_invite

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/session/invite \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/session/invite HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "call_id": "string",
  "contact_tokens": [
    "string"
  ],
  "user_token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/session/invite',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/session/invite',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/session/invite', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/session/invite', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/session/invite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/session/invite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/session/invite

Invite a guest into the video session

Body parameter

{
  "call_id": "string",
  "contact_tokens": [
    "string"
  ],
  "user_token": "string"
}

Parameters

Name In Type Required Description
authorization header string true An session authorization token
body body object true none
» call_id body string true The Gss call id
» contact_tokens body [string] true User tokens to send the invite to. Requires :add_to_session permission.
» user_token body string true User's token

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successfully sent the invite. None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE _v1_session_video

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/session/video?user_token=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/session/video?user_token=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/session/video?user_token=string',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/session/video',
  params: {
  'user_token' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/session/video', params={
  'user_token': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/session/video', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/session/video?user_token=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/session/video", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/session/video

Cancel a video request. This will inform other users to stop their incoming call ring

Parameters

Name In Type Required Description
authorization header string true An session authorization token
user_token query string true User's token

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successfully canceled the request. None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_session_video

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/session/video \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/session/video HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "user_token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/session/video',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/session/video',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/session/video', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/session/video', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/session/video");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/session/video", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/session/video

Request video on a session. This will ring all other users. Use a session token as authorization

Body parameter

{
  "user_token": "string"
}

Parameters

Name In Type Required Description
authorization header string true An session authorization token
body body object true none
» user_token body string true User's token

Example responses

200 Response

{
  "gss_info": {
    "server": "string",
    "token": "string",
    "wsserver": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Gss Authentication information. session_authV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_sessions

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/sessions \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/sessions HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/sessions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/sessions',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/sessions', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/sessions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/sessions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/sessions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/sessions

Return a list of recent sessions

Parameters

Name In Type Required Description
authorization header string true A user authorization token
max_sessions query integer false none

Example responses

200 Response

{
  "entries": [
    {
      "id": "string",
      "pin": "string",
      "token": "string",
      "updated_at": "string",
      "users": [
        {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "name": "string",
          "status": 0,
          "token": "string",
          "username": "string"
        }
      ],
      "video_active": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK A list of sessions. sessions
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_sessions

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/sessions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/sessions HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "contact_tokens": [
    "string"
  ],
  "force_new": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/sessions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/sessions',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/sessions', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/sessions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/sessions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/sessions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/sessions

Creates a new session, returning a token that can be used for /session routes

Body parameter

{
  "contact_tokens": [
    "string"
  ],
  "force_new": true
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» contact_tokens body [string] true User's tokens. Requires :add_to_session permission.
» force_new body boolean false Force a new, unique session_id to be created.

Example responses

200 Response

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string",
      "status": 0,
      "token": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Responses

Status Meaning Description Schema
200 OK Success, new session object with a token is returned. sessionV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_sessions_help

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/sessions/help \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/sessions/help HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "enterprise_id": 0,
  "group_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/sessions/help',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/sessions/help',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/sessions/help', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/sessions/help', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/sessions/help");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/sessions/help", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/sessions/help

Create a new expert group session

Body parameter

{
  "enterprise_id": 0,
  "group_id": 0
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» enterprise_id body integer true The Enterprise Id that owns the expert group
» group_id body integer true The Expert Group Id

Example responses

200 Response

{
  "request_id": "string",
  "sesseion_auth": {
    "gss_info": {
      "server": "string",
      "token": "string",
      "wsserver": "string"
    },
    "session_info": {
      "id": "string",
      "pin": "string",
      "token": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "users": [
        "string"
      ],
      "video_active": true
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Success get_help_response
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_sessions_link

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/sessions/link \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/sessions/link HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "linkType": "mhs",
  "sessionId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/sessions/link',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/sessions/link',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/sessions/link', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/sessions/link', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/sessions/link");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/sessions/link", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/sessions/link

Creates a session link

Body parameter

{
  "linkType": "mhs",
  "sessionId": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object false none
» linkType body string false The link type, either mhs (My Help Space), tpi (third-party invite) or One Time Use (otu), defaults to otu.
» sessionId body string false The session id, if creating a third-party invite link

Enumerated Values

Parameter Value
» linkType mhs
» linkType otu
» linkType tpi

Example responses

200 Response

{
  "link": "string",
  "long_link": "string",
  "signature": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the new session link Inline
400 Bad Request Could not complete the request due to invalid parameters. errorV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» link string false none The session link, as a string. Should be used for /sessions/link/invite
» long_link string false none The non-shortened version of the link
» signature string false none The session link signature, as a string

POST _v1_sessions_link_invite

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/sessions/link/invite \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/sessions/link/invite HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "link": "string",
  "linkType": 0,
  "message": "string",
  "recipientEmail": "string",
  "recipientName": "string",
  "recipientPhoneNumber": "string",
  "signature": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/sessions/link/invite',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/sessions/link/invite',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/sessions/link/invite', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/sessions/link/invite', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/sessions/link/invite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/sessions/link/invite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/sessions/link/invite

Send personal room link or one time link via email or sms

Body parameter

{
  "link": "string",
  "linkType": 0,
  "message": "string",
  "recipientEmail": "string",
  "recipientName": "string",
  "recipientPhoneNumber": "string",
  "signature": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» link body string false A pregenerated one-time-use-link
» linkType body integer false A personal room link(1) or one time link(2)
» message body string false Message
» recipientEmail body string false Must specify at least a phone number or email
» recipientName body string false Name of the recipient
» recipientPhoneNumber body string false Must specify at least a phone number or email
» signature body string false A signature string for a pregenerated link

Example responses

200 Response

{
  "email_result": 0,
  "sms_result": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns result object. Inline
400 Bad Request Could not complete the request due to invalid parameters. errorV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» email_result integer false none 0 - succeed, 1 - failed, 2 - ignored
» sms_result integer false none 0 - succeed, 1 - failed, 2 - ignored

GET v1_sessions{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/sessions/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/sessions/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/sessions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/sessions/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/sessions/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/sessions/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/sessions/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/sessions/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/sessions/{id}

Get a Session based on Id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path string true Session ID

Example responses

200 Response

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string",
      "status": 0,
      "token": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Responses

Status Meaning Description Schema
200 OK The session sessionV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
403 Forbidden Could not find resource or you do not have access to the resource. errorV1
404 Not Found Resource Not Found errorV1
500 Internal Server Error Internal error errorV1

POST _v1_validate_one_time_link

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/validate_one_time_link?url=string \
  -H 'Accept: link expired' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/validate_one_time_link?url=string HTTP/1.1
Host: api.helplightning.net
Accept: link expired



const headers = {
  'Accept':'link expired',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/validate_one_time_link?url=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'link expired',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/validate_one_time_link',
  params: {
  'url' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'link expired',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/validate_one_time_link', params={
  'url': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'link expired',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/validate_one_time_link', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/validate_one_time_link?url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"link expired"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/validate_one_time_link", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/validate_one_time_link

Validate an one time link

Parameters

Name In Type Required Description
url query string true none

Example responses

Success

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

GET v1r1_call{call_id}_survey

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/call/{call_id}/survey \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/call/{call_id}/survey HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/call/{call_id}/survey',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/call/{call_id}/survey',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/call/{call_id}/survey', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/call/{call_id}/survey', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/call/{call_id}/survey");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/call/{call_id}/survey", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/call/{call_id}/survey

Get the survey url by a call id for a user.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID

Example responses

200 Response

{
  "name": "string",
  "url": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns enterprise survey url information map. call_survey
400 Bad Request A generic error response errorV1R1

GET _v1r1_link_info

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/link/info?link_url=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/link/info?link_url=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/link/info?link_url=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/link/info',
  params: {
  'link_url' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/link/info', params={
  'link_url': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/link/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/link/info?link_url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/link/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/link/info

Get link information

Parameters

Name In Type Required Description
authorization header string true A user authorization token
link_url query string true The link url

Example responses

200 Response

{
  "creator": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "status": 0,
    "username": "string"
  },
  "session": {
    "id": "string",
    "pin": "string",
    "token": "string",
    "updated_at": "string",
    "users": [
      {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "name": "string",
        "status": 0,
        "token": "string",
        "username": "string"
      }
    ],
    "video_active": true
  },
  "workflow": 0
}

Responses

Status Meaning Description Schema
200 OK The link information. link_info
400 Bad Request A generic error response errorV1R1

POST _v1r1_personal_room_invite

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/personal_room/invite \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/personal_room/invite HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/personal_room/invite',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/personal_room/invite',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/personal_room/invite', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/personal_room/invite', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/personal_room/invite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/personal_room/invite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/personal_room/invite

Invite someone to our personal room. Only certain enterprise users have a personal room.

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_session_auth

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/session/auth \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/session/auth HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/session/auth',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/session/auth',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/session/auth', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/session/auth', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/session/auth");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/session/auth", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/session/auth

Get session auth

Parameters

Name In Type Required Description
authorization header string true An session authorization token

Example responses

200 Response

{
  "gss_info": {
    "server": "string",
    "token": "string",
    "wsserver": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK The session auth object session_authV1
400 Bad Request A generic error response errorV1R1

DELETE _v1r1_session_video

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/session/video \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/session/video HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/session/video',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/session/video',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/session/video', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/session/video', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/session/video");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/session/video", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/session/video

Cancel an existing video request for a session

Parameters

Name In Type Required Description
authorization header string true An session authorization token

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

POST _v1r1_session_video

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/session/video \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/session/video HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/session/video',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/session/video',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/session/video', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/session/video', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/session/video");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/session/video", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/session/video

Start a video request for a session

Parameters

Name In Type Required Description
authorization header string true An session authorization token

Example responses

200 Response

{
  "request_id": "string",
  "request_ids": [
    "string"
  ],
  "session_auth": {
    "gss_info": {
      "server": "string",
      "token": "string",
      "wsserver": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK The request authorization session_request_auth
400 Bad Request A generic error response errorV1R1

POST _v1r1_session_video_accept

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/session/video/accept \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/session/video/accept HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "request_id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/session/video/accept',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/session/video/accept',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/session/video/accept', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/session/video/accept', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/session/video/accept");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/session/video/accept", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/session/video/accept

Accept a video request in a session

Body parameter

{
  "request_id": "string"
}

Parameters

Name In Type Required Description
authorization header string true An session authorization token
body body object true none
» request_id body string false The request Id

Example responses

200 Response

{
  "gss_info": {
    "server": "string",
    "token": "string",
    "wsserver": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK The request authorization session_authV1
400 Bad Request A generic error response errorV1R1

POST _v1r1_session_video_decline

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/session/video/decline \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/session/video/decline HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "message": "string",
  "reason": 0,
  "request_id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/session/video/decline',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/session/video/decline',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/session/video/decline', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/session/video/decline', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/session/video/decline");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/session/video/decline", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/session/video/decline

Decline a video request in a session

Body parameter

{
  "message": "string",
  "reason": 0,
  "request_id": "string"
}

Parameters

Name In Type Required Description
authorization header string true An session authorization token
body body object true none
» message body string false An extended message on why this call is being declined
» reason body integer false The reason why this call is being declined.
» request_id body string false The request Id

Detailed descriptions

» reason: The reason why this call is being declined. 0 = Declined, 1 = Busy, 2 = Not Answered (User took no action and the call timed out), 3 = No Expert is available.

Enumerated Values

Parameter Value
» reason 0
» reason 1
» reason 2
» reason 3

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET v1r1_user_calls{call_id}_attachments

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/calls/{call_id}/attachments

Get attachments for session call

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID

Example responses

200 Response

[
  {
    "creator": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "deleted": true,
    "id": 0,
    "mime_type": "string",
    "name": "string",
    "path": "string",
    "progress": 0,
    "signed_url": "string",
    "status": "string",
    "thumbnail": "string",
    "timestamp": "string",
    "type": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns list of attachments Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [call_attachmentV1R1] false none none
» creator attachment_creator false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none User identifier
»» name string false none Display name of user
» deleted boolean false none none
» id integer(int32) false none Call attachment identifier
» mime_type string false none none
» name string false none none
» path string false none none
» progress integer false none none
» signed_url string false none none
» status string false none none
» thumbnail string false none none
» timestamp string false none none
» type string false none none

POST v1r1_user_calls{call_id}_attachments

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "attachment": "string",
  "mime_type": "string",
  "name": "string",
  "timestamp": 0,
  "type": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/user/calls/{call_id}/attachments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/user/calls/{call_id}/attachments

Creates a call attachment

Body parameter

{
  "attachment": "string",
  "mime_type": "string",
  "name": "string",
  "timestamp": 0,
  "type": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID
body body object true none
» attachment body string true File attachment (multipart upload)
» mime_type body string true Mime-type of the file
» name body string true Name of the file
» timestamp body integer true Linux timestamp when the file was creating if type is incall
» type body string true incall, postcall or recording

Example responses

200 Response

{
  "creator": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "name": "string"
  },
  "deleted": true,
  "id": 0,
  "mime_type": "string",
  "name": "string",
  "path": "string",
  "progress": 0,
  "signed_url": "string",
  "status": "string",
  "thumbnail": "string",
  "timestamp": "string",
  "type": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, creates a attachment on the call and returns info about it call_attachmentV1R1
400 Bad Request A generic error response errorV1R1

GET v1r1_user_calls{call_id}_comments

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/calls/{call_id}/comments

Get comments for session call

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID

Example responses

200 Response

[
  {
    "comment": "string",
    "creator": [
      {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "name": "string",
        "username": "string"
      }
    ],
    "enterprise_id": "string",
    "id": 0,
    "inserted_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns list of comments Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [call_comment] false none none
» comment string false none The comment text
» creator [comments_creator] false none The user that added the comment
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none User identifier
»» name string false none Display name of user
»» username string false none Username of user
» enterprise_id string false none Enterprise ID that the comment exists in
» id integer(int32) false none Call comment identifier
» inserted_at string(date-time) false none none
» updated_at string(date-time) false none none

POST v1r1_user_calls{call_id}_comments

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "comment": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/user/calls/{call_id}/comments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/user/calls/{call_id}/comments

Creates a call comment

Body parameter

{
  "comment": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID
body body object false none
» comment body string false Call comment text

Example responses

200 Response

{
  "comment": "string",
  "creator": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string",
      "username": "string"
    }
  ],
  "enterprise_id": "string",
  "id": 0,
  "inserted_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Success, creates a comment on the call and returns info about it call_comment
400 Bad Request A generic error response errorV1R1

POST v1r1_user_calls{call_id}_rating

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "rating": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/user/calls/{call_id}/rating", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/user/calls/{call_id}/rating

Adds a rating to a call

Body parameter

{
  "rating": 0
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID
body body object true none
» rating body integer(int32) false A call rating from 1-5

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

POST v1r1_user_calls{call_id}_tags

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/user/calls/{call_id}/tags

Adds a list of tags to a call

Body parameter

[
  "string"
]

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID
body body array[string] true none

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

PUT v1r1_user_calls{call_id}_tags

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/user/calls/{call_id}/tags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/user/calls/{call_id}/tags

Set the list of tags for a call

Body parameter

[
  "string"
]

Parameters

Name In Type Required Description
authorization header string true A user authorization token
call_id path string true Call ID
body body array[string] true none

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_workbox_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/calls

Paginate calls for a workbox (v2)

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor to retrieve results from, optional
order_by query string false Orders the resulting calls, defaults to descending call date

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "alt1_id": "string",
      "alt2_id": "string",
      "alt3_id": "string",
      "call_duration": 0,
      "call_id": "string",
      "dialer": {
        "email": "string",
        "enterprise_id": 0,
        "id": 0,
        "is_anonymous": true,
        "name": "string",
        "username": "string"
      },
      "extra_info": "string",
      "has_attachments": true,
      "intra_enterprise_call": true,
      "owner_email": "string",
      "owner_id": "string",
      "owner_name": "string",
      "participants": [
        {
          "email": "string",
          "enterprise_id": 0,
          "id": 0,
          "is_anonymous": true,
          "name": "string",
          "username": "string"
        }
      ],
      "reason_call_ended": "string",
      "time_call_ended": 0,
      "time_call_started": 0,
      "timestamp": "string"
    }
  ],
  "total_count": 0
}

Responses

Status Meaning Description Schema
200 OK Successfully retrieved workbox calls Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning calls in subsequent calls
» entries [enterprise_call_brief] false none none
»» alt1_id string false none none
»» alt2_id string false none none
»» alt3_id string false none none
»» call_duration integer false none Duration of the call in seconds
»» call_id string false none none
»» dialer enterprise_call_user false none none
»»» email string false none none
»»» enterprise_id integer(int32) false none none
»»» id integer(int32) false none none
»»» is_anonymous boolean false none none
»»» name string false none none
»»» username string false none none
»» extra_info string false none none
»» has_attachments boolean false none none
»» intra_enterprise_call boolean false none none
»» owner_email string false none none
»» owner_id string false none none
»» owner_name string false none none
»» participants [enterprise_call_user] false none none
»» reason_call_ended string false none none
»» time_call_ended number false none none
»» time_call_started number false none none
»» timestamp string false none none
» total_count integer false none none

User-Level: Account Management

Account Management

PUT _v1_change_password

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/change_password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/change_password HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "new_password": "string",
  "password_token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/change_password',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/change_password',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/change_password', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/change_password', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/change_password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/change_password", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/change_password

Changes the user's password

Body parameter

{
  "new_password": "string",
  "password_token": "string"
}

Parameters

Name In Type Required Description
body body object true none
» new_password body string true New password
» password_token body string false Password token which is generated from reset password

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_change_password_policy

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/change_password/policy?password_token=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/change_password/policy?password_token=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/change_password/policy?password_token=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/change_password/policy',
  params: {
  'password_token' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/change_password/policy', params={
  'password_token': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/change_password/policy', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/change_password/policy?password_token=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/change_password/policy", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/change_password/policy

Gets the password policy rules given a reset password token

Parameters

Name In Type Required Description
password_token query string true Password Token

Example responses

200 Response

{
  "password_required_description": "string",
  "rules": [
    {
      "regex": "string",
      "required": "string",
      "text": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success password_policyV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_password_policy

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/password_policy \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/password_policy HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/password_policy',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/password_policy',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/password_policy', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/password_policy', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/password_policy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/password_policy", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/password_policy

Gets the password policy rules for new accounts for an enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "password_required_description": "string",
  "rules": [
    {
      "regex": "string",
      "required": "string",
      "text": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success password_policyV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_info

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/info \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/info HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/info

Returns a summary of the user as a map.

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success user
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT _v1_info

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/info HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "email": "string",
  "name": "string",
  "password": "string",
  "status": "string",
  "username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/info',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/info

Set user info

Body parameter

{
  "email": "string",
  "name": "string",
  "password": "string",
  "status": "string",
  "username": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» email body string false New email of the user
» name body string false New display name of the user
» password body string false New password of user
» status body string false Sets the status of the user account. Possible values include 100 (online), 101 (offline), 102 (busy), 103 (idle), 104 (dnd), and 105 (invited)
» username body string false New username of the user

Example responses

200 Response

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success user
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_info_avatar

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/info/avatar \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/info/avatar HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/info/avatar',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/info/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/info/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/info/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/info/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/info/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/info/avatar

Returns a URL of the user's avatar

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "full": "string",
  "thumb": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns info about avatar URL avatarV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT _v1_info_avatar

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/info/avatar \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/info/avatar HTTP/1.1
Host: api.helplightning.net
Content-Type: application/octet-stream
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/info/avatar',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/octet-stream',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/info/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/octet-stream',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/info/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/octet-stream',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/info/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/info/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/octet-stream"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/info/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/info/avatar

Uploads a new avatar image

Body parameter

string

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body string(binary) true none

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success, returns avatar URL string
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE _v1_info_unavailable

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/info/unavailable \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/info/unavailable HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/info/unavailable',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/info/unavailable',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/info/unavailable', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/info/unavailable', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/info/unavailable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/info/unavailable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/info/unavailable

Clears the user unavailable flag

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_info_unavailable

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/info/unavailable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/info/unavailable HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "expires_after": 0,
  "status_message": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/info/unavailable',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/info/unavailable',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/info/unavailable', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/info/unavailable', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/info/unavailable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/info/unavailable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/info/unavailable

Sets the user as unavailable, with an optional custom message

Body parameter

{
  "expires_after": 0,
  "status_message": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» expires_after body integer(int32) false Number of seconds until the unavailable status expires
» status_message body string false New status message of the user, optional

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_invitation

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/invitation \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/invitation HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/invitation',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/invitation',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/invitation', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/invitation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/invitation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/invitation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/invitation

Gets a summary of an invitation

Parameters

Name In Type Required Description
authorization header string true An invitation authorization token

Example responses

200 Response

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "personas": [
    "string"
  ],
  "pods": [
    "string"
  ],
  "status": "string",
  "user_exists": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns invitation information map or none enterprise_invitationV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_password_policy

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/password_policy \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/password_policy HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/password_policy',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/password_policy',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/password_policy', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/password_policy', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/password_policy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/password_policy", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/password_policy

Gets the password policy rules for new accounts

Example responses

200 Response

{
  "password_required_description": "string",
  "rules": [
    {
      "regex": "string",
      "required": "string",
      "text": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success password_policyV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_reset_password

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/reset_password?username_or_email=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/reset_password?username_or_email=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/reset_password?username_or_email=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/reset_password',
  params: {
  'username_or_email' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/reset_password', params={
  'username_or_email': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/reset_password', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/reset_password?username_or_email=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/reset_password", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/reset_password

Requests a reset password email for a user by email or username

Parameters

Name In Type Required Description
username_or_email query string true none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT _v1r1_change_password

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/change_password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/change_password HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "new_password": "string",
  "password_token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/change_password',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/change_password',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/change_password', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/change_password', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/change_password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/change_password", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/change_password

Changes the user's password

Body parameter

{
  "new_password": "string",
  "password_token": "string"
}

Parameters

Name In Type Required Description
body body object true none
» new_password body string true New password
» password_token body string true Password token which is generated from reset password

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

POST _v1r1_device

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/device \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/device HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "device_id": "string",
  "platform": "gcm",
  "push_id": "string",
  "app_id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/device',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/device',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/device', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/device', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/device");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/device", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/device

Set device push identifier

Body parameter

{
  "device_id": "string",
  "platform": "gcm",
  "push_id": "string",
  "app_id": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» device_id body string false The device id
» platform body string false The device platform
» push_id body string false The device push identifier
» app_id body string false The device app identifier

Enumerated Values

Parameter Value
» platform gcm
» platform apns
» platform apnspk
» platform web

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

DELETE v1r1_device{device_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/device/{device_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/device/{device_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/device/{device_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/device/{device_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/device/{device_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/device/{device_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/device/{device_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/device/{device_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/device/{device_id}

Delete push identifier

Parameters

Name In Type Required Description
authorization header string true A user authorization token
device_id path string true The device push identifier

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_features

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/features \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/features HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/features',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/features',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/features', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/features', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/features");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/features", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/features

Gets all available features

Example responses

200 Response

[
  {
    "description": "string",
    "id": 0,
    "name": "string",
    "var": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns list of all features Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [permission] false none none
» description string false none Description of the permission
» id integer(int32) false none The ID for the permission
» name string false none Name of permission
» var string false none Human-readable unique identifier of the permission

GET _v1r1_personal_room_disclaimer

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/personal_room/disclaimer?meeting_url=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/personal_room/disclaimer?meeting_url=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/personal_room/disclaimer?meeting_url=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/personal_room/disclaimer',
  params: {
  'meeting_url' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/personal_room/disclaimer', params={
  'meeting_url': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/personal_room/disclaimer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/personal_room/disclaimer?meeting_url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/personal_room/disclaimer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/personal_room/disclaimer

Gets the disclaimer for a personal room or expert group URL

Parameters

Name In Type Required Description
authorization header string true A user authorization token
meeting_url query string true The meeting room or expert group URL

Example responses

200 Response

{
  "delete_user_upon_decline": true,
  "disclaimer_text": "string",
  "enterprise_id": "string",
  "enterprise_name": "string",
  "needs_acceptance": true
}

Responses

Status Meaning Description Schema
200 OK success, returns disclaimer user_disclaimer
400 Bad Request A generic error response errorV1R1

POST _v1r1_personal_room_disclaimer

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/personal_room/disclaimer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/personal_room/disclaimer HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "accept": true,
  "meeting_url": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/personal_room/disclaimer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/personal_room/disclaimer',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/personal_room/disclaimer', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/personal_room/disclaimer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/personal_room/disclaimer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/personal_room/disclaimer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/personal_room/disclaimer

Accepts or declines the disclaimer for a personal room or expert group URL

Body parameter

{
  "accept": true,
  "meeting_url": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» accept body boolean false Whether or not to accep the disclaimer
» meeting_url body string false The meeting room or expert group URL

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK success, disclaimer accepted or declined None
400 Bad Request A generic error response errorV1R1

GET _v1r1_user

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user

Returns a summary of the user as a map.

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "active": true,
  "admin_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "auth_type": "string",
  "available": true,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "email_confirmed": true,
  "expert_on_call": true,
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "language": "string",
  "last_used_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "location": "string",
  "name": "string",
  "oauth2": {
    "account_url": "string",
    "logout_url": "string",
    "provider": "string"
  },
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "phone": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "title": "string",
  "token_permissions": [
    "string"
  ],
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK success, personal user model returned personal_user
400 Bad Request A generic error response errorV1R1

PUT _v1r1_user

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/user \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/user HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "email": "string",
  "expert_on_call": true,
  "language": "",
  "location": "",
  "name": "string",
  "password": "string",
  "phone": "",
  "title": "",
  "username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/user',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/user', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/user', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/user", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/user

Set user info

Body parameter

{
  "email": "string",
  "expert_on_call": true,
  "language": "",
  "location": "",
  "name": "string",
  "password": "string",
  "phone": "",
  "title": "",
  "username": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» email body string false New email of the user
» expert_on_call body boolean false Whether or not this user is on call
» language body string false Preferred language of user
» location body string false Location of the contact
» name body string false New display name of the user
» password body string false New password of user
» phone body string false Phone number of user
» title body string false Title of the contact
» username body string false New username of the user

Example responses

200 Response

{
  "active": true,
  "admin_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "auth_type": "string",
  "available": true,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "email_confirmed": true,
  "expert_on_call": true,
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "language": "string",
  "last_used_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "location": "string",
  "name": "string",
  "oauth2": {
    "account_url": "string",
    "logout_url": "string",
    "provider": "string"
  },
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "phone": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "title": "string",
  "token_permissions": [
    "string"
  ],
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK success, user updated and personal user model returned personal_user
400 Bad Request A generic error response errorV1R1

GET _v1r1_user_disclaimer

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/disclaimer \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/disclaimer HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/disclaimer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/disclaimer',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/disclaimer', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/disclaimer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/disclaimer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/disclaimer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/disclaimer

Get the disclaimer for our enterprise

Example responses

200 Response

{
  "delete_user_upon_decline": true,
  "disclaimer_text": "string",
  "enterprise_id": "string",
  "enterprise_name": "string",
  "needs_acceptance": true
}

Responses

Status Meaning Description Schema
200 OK success, returns disclaimer user_disclaimer
400 Bad Request A generic error response errorV1R1

POST _v1r1_user_disclaimer

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/user/disclaimer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/user/disclaimer HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "accept": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/disclaimer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/user/disclaimer',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/user/disclaimer', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/user/disclaimer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/disclaimer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/user/disclaimer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/user/disclaimer

We have accepted or declined to accept OUR enterprises disclaimer. This should be called in response to the GET /user/disclaimer method

Body parameter

{
  "accept": true
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object false none
» accept body boolean false Whether or not you accept the disclaimer

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

get_user_badges

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/badges \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/badges HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/badges',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/badges',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/badges', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/badges', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/badges");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/badges", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/badges

Get all badge counts for a user's app

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "workboxes_unread_count": 0,
  "unassigned_count": 0,
  "sessions_unread_count": 0,
  "app_badge_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of queues badges
400 Bad Request A generic error response errorV1R1

User-Level: Enterprise Management

Enterprise Management

GET _v1_enterprises

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprises \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprises HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprises',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprises',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprises', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprises', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprises");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprises", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprises

Gets a list of enterprises user is a member of

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "active_user_count": 0,
      "auto_accept": true,
      "branding_locked": true,
      "contact_email": "string",
      "contact_name": "string",
      "contact_phone": "string",
      "description": "string",
      "domains": [
        "string"
      ],
      "id": 0,
      "lock_devices": true,
      "max_users": "string",
      "name": "string",
      "time_zone": "string",
      "token": "string",
      "translation_file_url": "string",
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a list of enterprise information in a map. enterprises
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprises_invitations

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprises/invitations \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprises/invitations HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprises/invitations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprises/invitations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprises/invitations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprises/invitations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprises/invitations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprises/invitations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprises/invitations

Gets invitations to enterprises.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "email": "string",
      "enterprise_name": "string",
      "id": 0,
      "invitation_sent_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "personas": [
        "string"
      ],
      "pods": [
        "string"
      ],
      "status": "string",
      "user_exists": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a list of enterprise invitations as a map. invitations
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_enterprises_invitations{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprises/invitations/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprises/invitations/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprises/invitations/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprises/invitations/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprises/invitations/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprises/invitations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprises/invitations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprises/invitations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprises/invitations/{id}

Deletes an invitation from an enterprise.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Invitation ID

Example responses

200 Response

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "personas": [
    "string"
  ],
  "pods": [
    "string"
  ],
  "status": "string",
  "user_exists": true
}

Responses

Status Meaning Description Schema
200 OK Success, invitation removed enterprise_invitationV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprises_invitations{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprises/invitations/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprises/invitations/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprises/invitations/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprises/invitations/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprises/invitations/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprises/invitations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprises/invitations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprises/invitations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprises/invitations/{id}

Gets an invitation to an enterprise.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Invitation ID

Example responses

200 Response

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "personas": [
    "string"
  ],
  "pods": [
    "string"
  ],
  "status": "string",
  "user_exists": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns updated enterprise invitation as a map. enterprise_invitationV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprises_invitations{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprises/invitations/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprises/invitations/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "action": "string",
  "email": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprises/invitations/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprises/invitations/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprises/invitations/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprises/invitations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprises/invitations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprises/invitations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprises/invitations/{id}

Updates an enterprise invitation.

Body parameter

{
  "action": "string",
  "email": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Invitation ID
body body object true Action to take on the enterprise invitation
» action body string true Action to take, may be 'accept', 'reject', or 'change_email'
» email body string false If action is change_email then this should contain the new email to request.

Example responses

200 Response

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "personas": [
    "string"
  ],
  "pods": [
    "string"
  ],
  "status": "string",
  "user_exists": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns an enterprise invitation as a map. enterprise_invitationV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

User-Level: Contacts

Contact Management

GET _v1_colleagues

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/colleagues \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/colleagues HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/colleagues',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/colleagues',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/colleagues', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/colleagues', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/colleagues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/colleagues", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/colleagues

List of colleagues. Colleagues are users visible to us through the enterprise.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "available": "string",
      "avatar": "string",
      "confirmed_email": true,
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "permissions": [
        "string"
      ],
      "personal_room_session_id": "string",
      "personal_room_url": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success colleagues
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_colleagues{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/colleagues/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/colleagues/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/colleagues/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/colleagues/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/colleagues/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/colleagues/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/colleagues/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/colleagues/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/colleagues/{id}

Summarizes a colleague. Colleagues are users visible to us through the enterprise.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Colleague ID

Example responses

200 Response

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success user
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_contact_request

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contact_request \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contact_request HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_request',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contact_request',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contact_request', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contact_request', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_request");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contact_request", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contact_request

Gets a summary of a contact request

Parameters

Name In Type Required Description
authorization header string true A contact request authorization token

Example responses

200 Response

{
  "avatar": "string",
  "id": 0,
  "name": "string",
  "requestee_email": "string",
  "requestee_name": "string",
  "status": "string",
  "user_exists": true,
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns contact request information map or none contact_request_incoming
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_contact_requests_incoming

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contact_requests/incoming \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contact_requests/incoming HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_requests/incoming',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contact_requests/incoming',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contact_requests/incoming', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contact_requests/incoming', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_requests/incoming");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contact_requests/incoming", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contact_requests/incoming

Return incoming contact requests. These are people that have invited you.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": "string",
      "id": 0,
      "name": "string",
      "requestee_email": "string",
      "requestee_name": "string",
      "status": "string",
      "user_exists": true,
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success contact_requests_incoming
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_contact_requests_incoming{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contact_requests/incoming/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contact_requests/incoming/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_requests/incoming/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contact_requests/incoming/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contact_requests/incoming/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contact_requests/incoming/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_requests/incoming/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contact_requests/incoming/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contact_requests/incoming/{id}

Returns an incoming contact request (request sent from another user)

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Incoming contact request ID

Example responses

200 Response

{
  "avatar": "string",
  "id": 0,
  "name": "string",
  "requestee_email": "string",
  "requestee_name": "string",
  "status": "string",
  "user_exists": true,
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success contact_request_incoming
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_contact_requests_incoming{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/contact_requests/incoming/{id}?action=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/contact_requests/incoming/{id}?action=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_requests/incoming/{id}?action=string',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/contact_requests/incoming/{id}',
  params: {
  'action' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/contact_requests/incoming/{id}', params={
  'action': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/contact_requests/incoming/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_requests/incoming/{id}?action=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/contact_requests/incoming/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/contact_requests/incoming/{id}

Updates an incoming contact request (accept or deny)

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Incoming contact request ID
action query string true Action ('accept' or 'deny')

Example responses

200 Response

{
  "avatar": "string",
  "id": 0,
  "name": "string",
  "requestee_email": "string",
  "requestee_name": "string",
  "status": "string",
  "user_exists": true,
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success contact_request_incoming
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_contact_requests_outgoing

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contact_requests/outgoing \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contact_requests/outgoing HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_requests/outgoing',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contact_requests/outgoing',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contact_requests/outgoing', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contact_requests/outgoing', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_requests/outgoing");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contact_requests/outgoing", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contact_requests/outgoing

Return outgoing contact requests. These are people that you have invited.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": "string",
      "id": 0,
      "name": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success contact_requests_outgoing
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_contact_requests_outgoing

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/contact_requests/outgoing \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/contact_requests/outgoing HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "email_or_username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_requests/outgoing',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/contact_requests/outgoing',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/contact_requests/outgoing', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/contact_requests/outgoing', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_requests/outgoing");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/contact_requests/outgoing", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/contact_requests/outgoing

Creates a new contact request, and sends a notification to that user

Body parameter

{
  "email_or_username": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» email_or_username body string true Email or username of contact

Example responses

200 Response

{
  "avatar": "string",
  "id": 0,
  "name": "string",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success contact_request_outgoing
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_contact_requests_outgoing{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/contact_requests/outgoing/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/contact_requests/outgoing/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/contact_requests/outgoing/{id}

Cancels outgoing contact request

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Outgoing contact request ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_contact_requests_outgoing{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contact_requests/outgoing/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contact_requests/outgoing/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contact_requests/outgoing/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contact_requests/outgoing/{id}

Returns an outgoing contact request (request sent to a user)

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Outgoing contact request ID

Example responses

200 Response

{
  "avatar": "string",
  "id": 0,
  "name": "string",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success contact_request_outgoing
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_contacts

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contacts \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contacts HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contacts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contacts',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contacts', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contacts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contacts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contacts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contacts

List of user contacts

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "available": "string",
      "avatar": "string",
      "circles": [
        "string"
      ],
      "email": "string",
      "favorite": true,
      "id": 0,
      "name": "string",
      "status": "string",
      "token": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success contactsV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_contacts_circles{name}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contacts/circles/{name} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contacts/circles/{name} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contacts/circles/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contacts/circles/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contacts/circles/{name}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contacts/circles/{name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contacts/circles/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contacts/circles/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contacts/circles/{name}

Gets all contacts in a circle

Parameters

Name In Type Required Description
authorization header string true A user authorization token
name path string true Circle name

Example responses

200 Response

[
  {
    "available": "string",
    "avatar": "string",
    "circles": [
      "string"
    ],
    "email": "string",
    "favorite": true,
    "id": 0,
    "name": "string",
    "status": "string",
    "token": "string",
    "username": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [contactV1] false none none
» available string false none Whether the contact is available (ONLINE, BUSY, IDLE).
» avatar string false none Avatar URL of contact
» circles [string] false none Our circles that this contact is in.
» email string false none Email of contact
» favorite boolean false none Whether or not contact is favorited
» id integer(int32) false none Unique identifier for the contact
» name string false none Name of contact
» status string false none Status of contact
» token string false none Token for further actions on the contact.
» username string false none Username of contact

DELETE v1_contacts{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/contacts/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/contacts/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contacts/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/contacts/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/contacts/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/contacts/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contacts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/contacts/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/contacts/{id}

Delete a contact

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Contact ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_contacts{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contacts/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contacts/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contacts/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contacts/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contacts/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contacts/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contacts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contacts/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contacts/{id}

Gets a summary of a contact

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Contact ID

Example responses

200 Response

{
  "available": "string",
  "avatar": "string",
  "circles": [
    "string"
  ],
  "email": "string",
  "favorite": true,
  "id": 0,
  "name": "string",
  "status": "string",
  "token": "string",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success contactV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_contacts{id}_circles

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/contacts/{id}/circles \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/contacts/{id}/circles HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contacts/{id}/circles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/contacts/{id}/circles',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/contacts/{id}/circles', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/contacts/{id}/circles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contacts/{id}/circles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/contacts/{id}/circles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/contacts/{id}/circles

Gets circles that contact is in

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Contact ID

Example responses

200 Response

[
  "string"
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

POST v1_contacts{id}_circles

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/contacts/{id}/circles \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/contacts/{id}/circles HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contacts/{id}/circles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/contacts/{id}/circles',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/contacts/{id}/circles', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/contacts/{id}/circles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contacts/{id}/circles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/contacts/{id}/circles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/contacts/{id}/circles

Adds a contact to a circle.

Body parameter

"string"

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Contact ID
body body string true Name of circle to add contact into

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_contacts{id}circles{name}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/contacts/{id}/circles/{name} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/contacts/{id}/circles/{name} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/contacts/{id}/circles/{name}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/contacts/{id}/circles/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/contacts/{id}/circles/{name}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/contacts/{id}/circles/{name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/contacts/{id}/circles/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/contacts/{id}/circles/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/contacts/{id}/circles/{name}

Removes a contact from a circle

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Contact ID
name path string true Name of circle to remove contact from

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE _v1_favorites

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/favorites?id=0 \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/favorites?id=0 HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/favorites?id=0',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/favorites',
  params: {
  'id' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/favorites', params={
  'id': '0'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/favorites?id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/favorites

Unfavorites a contact, by their user id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id query integer(int32) true none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_favorites

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/favorites \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/favorites HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/favorites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/favorites',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/favorites', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/favorites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/favorites

List of user's favorite contacts and colleagues

Parameters

Name In Type Required Description
authorization header string true A user authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_favorites

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/favorites?id=0 \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/favorites?id=0 HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/favorites?id=0',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/favorites',
  params: {
  'id' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/favorites', params={
  'id': '0'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/favorites?id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/favorites

Favorites a contact, by their user id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id query integer(int32) true none

Example responses

200 Response

{
  "entries": [
    {
      "available": "string",
      "avatar": "string",
      "circles": [
        "string"
      ],
      "email": "string",
      "favorite": true,
      "id": 0,
      "name": "string",
      "status": "string",
      "token": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success contactsV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_search

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/search \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/search HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "include_token": false,
  "max_limit": 0,
  "search_term": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/search',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/search', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/search", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/search

Body parameter

{
  "include_token": false,
  "max_limit": 0,
  "search_term": "string"
}

Parameters

Name In Type Required Description
authorization header string true An user or enterprise authorization token
body body object true none
» include_token body boolean false Return a public user token in the results
» max_limit body integer false The maximum number of results
» search_term body string false Name or email address of the user

Example responses

200 Response

{
  "active": true,
  "avatar": [
    "string"
  ],
  "id": 0,
  "name": "string",
  "token": "string",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, creates a search result and returns info about it search_result
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE _v1r1_favorites

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/favorites?id=0 \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/favorites?id=0 HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/favorites?id=0',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/favorites',
  params: {
  'id' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/favorites', params={
  'id': '0'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/favorites?id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/favorites

Unfavorites a contact, by their user id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id query integer(int32) true none

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

POST _v1r1_favorites

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/favorites?id=0 \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/favorites?id=0 HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/favorites?id=0',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/favorites',
  params: {
  'id' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/favorites', params={
  'id': '0'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/favorites?id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/favorites

Favorites a contact, by their user id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id query integer(int32) true none

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

POST _v1r1_invite

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/invite \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/invite HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "contact_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/invite',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/invite',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/invite', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/invite', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/invite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/invite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/invite

Send a OTU invite to a contact that is currently unreachable.

Body parameter

{
  "contact_id": 0
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» contact_id body integer(int32) false User id to send the invite to.

Example responses

200 Response

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string",
      "status": 0,
      "token": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about a session link link_session
400 Bad Request A generic error response errorV1R1

GET _v1r1_user_search_directory

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/search/directory \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/search/directory HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/search/directory',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/search/directory',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/search/directory', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/search/directory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/search/directory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/search/directory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/search/directory

Searches our enterprise directory and returns a list of paginated contacts

Parameters

Name In Type Required Description
authorization header string true A user authorization token
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "favorite": true,
      "id": 0,
      "license": "string",
      "location": "string",
      "name": "string",
      "reachable": true,
      "supports_messaging": true,
      "title": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of contacts contactsV1R1
400 Bad Request A generic error response errorV1R1

GET _v1r1_user_search_favorites

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/search/favorites \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/search/favorites HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/search/favorites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/search/favorites',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/search/favorites', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/search/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/search/favorites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/search/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/search/favorites

Searches for favorite users

Parameters

Name In Type Required Description
authorization header string true A user authorization token
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "favorite": true,
      "id": 0,
      "license": "string",
      "location": "string",
      "name": "string",
      "reachable": true,
      "supports_messaging": true,
      "title": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of contacts contactsV1R1
400 Bad Request A generic error response errorV1R1

GET _v1r1_user_search_on_call_group_favorites

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/search/on_call_group_favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/search/on_call_group_favorites

Searches for on call group favorites

Parameters

Name In Type Required Description
authorization header string true A user authorization token
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "description": "string",
      "enterprise_id": 0,
      "favorite": true,
      "id": 0,
      "name": "string",
      "on_call_group": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of groups groups
400 Bad Request A generic error response errorV1R1

GET _v1r1_user_search_on_call_groups

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/search/on_call_groups \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/search/on_call_groups HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/search/on_call_groups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/search/on_call_groups',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/search/on_call_groups', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/search/on_call_groups', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/search/on_call_groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/search/on_call_groups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/search/on_call_groups

Searches for on call groups

Parameters

Name In Type Required Description
authorization header string true A user authorization token
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "description": "string",
      "enterprise_id": 0,
      "favorite": true,
      "id": 0,
      "name": "string",
      "on_call_group": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of groups groups
400 Bad Request A generic error response errorV1R1

GET _v1r1_user_search_personal

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/search/personal \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/search/personal HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/search/personal',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/search/personal',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/search/personal', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/search/personal', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/search/personal");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/search/personal", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/search/personal

Searches for personal users

Parameters

Name In Type Required Description
authorization header string true A user authorization token
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "favorite": true,
      "id": 0,
      "license": "string",
      "location": "string",
      "name": "string",
      "reachable": true,
      "supports_messaging": true,
      "title": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of contacts contactsV1R1
400 Bad Request A generic error response errorV1R1

GET _v1r1_user_search_team

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/search/team \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/search/team HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/search/team',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/search/team',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/search/team', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/search/team', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/search/team");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/search/team", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/search/team

Searches for other users in the team

Parameters

Name In Type Required Description
authorization header string true A user authorization token
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "favorite": true,
      "id": 0,
      "license": "string",
      "location": "string",
      "name": "string",
      "reachable": true,
      "supports_messaging": true,
      "title": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of contacts contactsV1R1
400 Bad Request A generic error response errorV1R1

User-Level: Help Threads

Help Threads

GET _v1r1_workbox

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox

Get a workbox by token

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

GET _v1r1_workbox_active_call

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/active_call \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/active_call HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/active_call',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/active_call',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/active_call', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/active_call', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/active_call");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/active_call", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/active_call

Get the active call in a workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token

Example responses

200 Response

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "active": true,
      "enterprise_id": 0,
      "id": "string",
      "name": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Responses

Status Meaning Description Schema
200 OK success, returns the session sessionV1R1
400 Bad Request A generic error response errorV1R1

POST _v1r1_workbox_close

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/close \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/close HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/close',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/close',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/close', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/close', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/close");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/close", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/close

Closes a workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

PUT _v1r1_workbox_custom_fields

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/workbox/custom_fields \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/workbox/custom_fields HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "values": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/custom_fields',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/workbox/custom_fields',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/workbox/custom_fields', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/workbox/custom_fields', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/custom_fields");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/workbox/custom_fields", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/workbox/custom_fields

Update custom fields in a workbox

Body parameter

{
  "values": [
    {}
  ]
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» values body [object] false workbox custom fields values

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

get_workbox_receipt_status

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/receipt_status \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/receipt_status HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/receipt_status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/receipt_status',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/receipt_status', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/receipt_status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/receipt_status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/receipt_status", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/receipt_status

Get the workbox receipt status for all messages

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token

Example responses

200 Response

{
  "most_recent_partial_received": 0,
  "most_recent_all_received": 0,
  "most_recent_partial_read": 0,
  "most_recent_all_read": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the workbox receipt status workbox_receipt_status
400 Bad Request A generic error response errorV1R1

POST _v1r1_workbox_invite

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/invite \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/invite HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "action": "string",
  "email": "string",
  "message": "string",
  "name": "string",
  "phone": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/invite',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/invite',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/invite', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/invite', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/invite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/invite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/invite

Invites a guest to the workbox

Body parameter

{
  "action": "string",
  "email": "string",
  "message": "string",
  "name": "string",
  "phone": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» action body string false An action to take. It can be an empty string, join_session, or start_procedure=$procedure_id
» email body string false Email of the guest to invite, optional
» message body string false Optional message to include in the invitation
» name body string true Name of the guest to invite
» phone body string false Phone number of the guest to invite in E.164 format

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK The modified workbox workbox
400 Bad Request A generic error response errorV1R1

POST _v1r1_workbox_invite_silent

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/invite/silent \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/invite/silent HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "action": "string",
  "email": "string",
  "message": "string",
  "name": "string",
  "phone": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/invite/silent',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/invite/silent',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/invite/silent', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/invite/silent', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/invite/silent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/invite/silent", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/invite/silent

Invites a guest to the workbox without sending an SMS or email

Body parameter

{
  "action": "string",
  "email": "string",
  "message": "string",
  "name": "string",
  "phone": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» action body string false An action to take. It can be an empty string, join_session, or start_procedure=$procedure_id
» email body string false Email of the guest to invite, optional
» message body string false Optional message to include in the invitation
» name body string true Name of the guest to invite
» phone body string false Phone number of the guest to invite in E.164 format

Example responses

200 Response

{
  "link": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK The link and modified workbox Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» link string false none Link that is normally sent to the guest via email or SMS
» workbox workbox false none none
»» assigned_at string false none none
»» closed_at string false none none
»» created_by brief_contact false none none
»»» avatar avatarV1 false none none
»»»» full string false none URL to full-size avatar
»»»» thumb string false none URL avatar thumbnail
»»» id integer(int32) false none ID of the user
»»» location string false none none
»»» name string false none none
»»» title string false none none
»»» username string false none none
»» description string false none none
»» fields [object] false none workbox custom fields
»» guests [workbox_guest] false none none
»»» has_joined boolean false none none
»»» id integer(int32) false none none
»»» last_read_message_id integer(int32) false none none
»»» name string false none none
»»» unread_count integer(int32) false none none
»»» uuid string false none none
»» queues [object] false none none
»»» id integer(int32) false none none
»»» name string false none none
»» assigned_to object false none none
»»» id integer(int32) false none none
»»» name string false none none
»» id integer(int32) false none The unique workbox ID
»» inserted_at string false none none
»» last_active_at string false none none
»» last_read_message_id integer(int32) false none none
»» participants [workbox_participant] false none none
»»» accepted_at string false none none
»»» assigned boolean false none Whether or not the associated workbox is assigned to this participant
»»» creator boolean false none Whether or not this user is the initial creator of the workbox
»»» has_participated boolean false none none
»»» id integer(int32) false none ID of the participant in the session (NOT the user id)
»»» important boolean false none Whether or not the user marked the associated workbox as important
»»» name string false none none
»»» removed boolean false none Whether or not this user was removed from the workbox
»» procedureCount number false none workbox procedures which does not deleted
»» procedures [object] false none workbox procedures
»» reported_at string false none none
»» status string false none Status of the workbox, may be REPORTED, ASSIGNED or CLOSED
»» ticketFieldsFull [object] false none workspace custom fields
»» token string false none A JWT used to manipulate the workbox
»» unread_messages_count integer(int32) false none none
»» updated_at string false none none
»» version string false none The version of the workbox

DELETE v1r1_workbox_invite{uuid}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/workbox/invite/{uuid} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/workbox/invite/{uuid} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/workbox/invite/{uuid}

Revokes a guest invite to the workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
uuid path string true UUID of the guest to delete

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK The modified workbox workbox
400 Bad Request A generic error response errorV1R1

POST v1r1_workbox_invite{uuid}

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/invite/{uuid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/invite/{uuid} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "action": "string",
  "message": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/invite/{uuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/invite/{uuid}

Resends the guest invitation to the workbox

Body parameter

{
  "action": "string",
  "message": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
uuid path string true UUID of the guest to reinvite
body body object true none
» action body string false An action to take. It can be an empty string, join_session, or start_procedure=$procedure_id
» message body string false Optional message to include in the invitation

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK The modified workbox workbox
400 Bad Request A generic error response errorV1R1

GET _v1r1_workbox_messages

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/messages \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/messages HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/messages',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/messages', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/messages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/messages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/messages

Get paginated list of messages for a workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.
after query string false Cursor for start of the results to return

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "deleted": true,
      "deleted_at": "string",
      "edited": true,
      "edited_at": "string",
      "id": 0,
      "internal": true,
      "metadata": "string",
      "read": true,
      "sent_at": "string",
      "type": "string",
      "user": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "user_name": "string",
      "uuid": "string",
      "version": 0,
      "workbox_id": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning message results in subsequent calls
» entries [workbox_message] false none none
»» deleted boolean false none none
»» deleted_at string false none none
»» edited boolean false none none
»» edited_at string false none none
»» id integer false none ID of the message in the workbox
»» internal boolean false none Whether or not this is an internal message
»» metadata string false none JSON data for the message, includes the message content
»» read boolean false none Whether or not the message has been read by you
»» sent_at string false none none
»» type string false none Type of the message
»» user brief_contact false none none
»»» avatar avatarV1 false none none
»»»» full string false none URL to full-size avatar
»»»» thumb string false none URL avatar thumbnail
»»» id integer(int32) false none ID of the user
»»» location string false none none
»»» name string false none none
»»» title string false none none
»»» username string false none none
»» user_name string false none Human readable name of the user who sent the message
»» uuid string false none none
»» version integer false none none
»» workbox_id integer false none ID of the workbox

POST _v1r1_workbox_messages

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/messages \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/messages HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "internal": true,
  "metadata": {},
  "sent_at": "string",
  "type": "Text",
  "username": "string",
  "uuid": "string",
  "version": 2
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/messages',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/messages', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/messages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/messages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/messages

Send a workbox message

Body parameter

{
  "internal": true,
  "metadata": {},
  "sent_at": "string",
  "type": "Text",
  "username": "string",
  "uuid": "string",
  "version": 2
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» internal body boolean false Whether or not this is an internal message
» metadata body object true JSON metadata for the content of the message
» sent_at body string false ISO8601 formatted timestamp when the message was sent, defaults to current time
» type body string true The type of message
» username body string true Human readable name
» uuid body string false Client-side generated UUID to identify the message, defaults to random UUID.
» version body integer false Optional, version of the workbox message, defaults to 2

Enumerated Values

Parameter Value
» type Text
» type QRMessage
» type Image
» type Video
» type Audio
» type Document
» type ProcedureState
» version 2
» version 1

Example responses

200 Response

{
  "deleted": true,
  "deleted_at": "string",
  "edited": true,
  "edited_at": "string",
  "id": 0,
  "internal": true,
  "metadata": "string",
  "read": true,
  "sent_at": "string",
  "type": "string",
  "user": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "user_name": "string",
  "uuid": "string",
  "version": 0,
  "workbox_id": 0
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox message that was created workbox_message
400 Bad Request A generic error response errorV1R1

GET _v1r1_workbox_messages_history_by_direction

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/messages/history_by_direction", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/messages/history_by_direction

Returns 'limit' messages before or after provided message ID

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id query integer(int32) false The ID to return messages before or after
direction query string false Either ASC or DESC, returns messages in ascending or descending order by sent_at timestamp
limit query integer(int32) false Maximum number of results to return. Defaults -1, return server configured amount.

Example responses

200 Response

[
  {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_message] false none none
» deleted boolean false none none
» deleted_at string false none none
» edited boolean false none none
» edited_at string false none none
» id integer false none ID of the message in the workbox
» internal boolean false none Whether or not this is an internal message
» metadata string false none JSON data for the message, includes the message content
» read boolean false none Whether or not the message has been read by you
» sent_at string false none none
» type string false none Type of the message
» user brief_contact false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none ID of the user
»» location string false none none
»» name string false none none
»» title string false none none
»» username string false none none
» user_name string false none Human readable name of the user who sent the message
» uuid string false none none
» version integer false none none
» workbox_id integer false none ID of the workbox

GET _v1r1_workbox_messages_recent_history

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/messages/recent_history \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/messages/recent_history HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/recent_history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/messages/recent_history',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/messages/recent_history', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/messages/recent_history', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/recent_history");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/messages/recent_history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/messages/recent_history

Returns 'limit' recent message history

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.

Example responses

200 Response

[
  {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_message] false none none
» deleted boolean false none none
» deleted_at string false none none
» edited boolean false none none
» edited_at string false none none
» id integer false none ID of the message in the workbox
» internal boolean false none Whether or not this is an internal message
» metadata string false none JSON data for the message, includes the message content
» read boolean false none Whether or not the message has been read by you
» sent_at string false none none
» type string false none Type of the message
» user brief_contact false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none ID of the user
»» location string false none none
»» name string false none none
»» title string false none none
»» username string false none none
» user_name string false none Human readable name of the user who sent the message
» uuid string false none none
» version integer false none none
» workbox_id integer false none ID of the workbox

GET _v1r1_workbox_messages_updates_since

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/messages/updates_since \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/messages/updates_since HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/updates_since',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/messages/updates_since',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/messages/updates_since', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/messages/updates_since', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/updates_since");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/messages/updates_since", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/messages/updates_since

Returns 'limit' messages since provided timestamp

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
timestamp query string false The time after which to return messages, as an ISO8601 formatted timestamp
limit query integer(int32) false Maximum number of results to return. Defaults -1, return server configured amount.

Example responses

200 Response

[
  {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_message] false none none
» deleted boolean false none none
» deleted_at string false none none
» edited boolean false none none
» edited_at string false none none
» id integer false none ID of the message in the workbox
» internal boolean false none Whether or not this is an internal message
» metadata string false none JSON data for the message, includes the message content
» read boolean false none Whether or not the message has been read by you
» sent_at string false none none
» type string false none Type of the message
» user brief_contact false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none ID of the user
»» location string false none none
»» name string false none none
»» title string false none none
»» username string false none none
» user_name string false none Human readable name of the user who sent the message
» uuid string false none none
» version integer false none none
» workbox_id integer false none ID of the workbox

DELETE v1r1_workbox_messages{message_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/workbox/messages/{message_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/workbox/messages/{message_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/workbox/messages/{message_id}

Delete message from existing workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Returns true None
400 Bad Request A generic error response errorV1R1

GET v1r1_workbox_messages{message_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/messages/{message_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/messages/{message_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/messages/{message_id}

Get a workbox message by id

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer true Workbox message ID

Example responses

200 Response

{
  "deleted": true,
  "deleted_at": "string",
  "edited": true,
  "edited_at": "string",
  "id": 0,
  "internal": true,
  "metadata": "string",
  "read": true,
  "sent_at": "string",
  "type": "string",
  "user": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "user_name": "string",
  "uuid": "string",
  "version": 0,
  "workbox_id": 0
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox message workbox_message
400 Bad Request A generic error response errorV1R1

PUT v1r1_workbox_messages{message_id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/workbox/messages/{message_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/workbox/messages/{message_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "metadata": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/workbox/messages/{message_id}

Edits message in existing workbox

Body parameter

{
  "metadata": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none
body body object true none
» metadata body string false JSON string of the new metadata for the message

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Returns true None
400 Bad Request A generic error response errorV1R1

POST v1r1_workbox_messages{message_id}_last_read_message

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/last_read_message", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/messages/{message_id}/last_read_message

Set the last read message for a user in a workbox. Use -1 or 0 for message_id to indicate the most recent message in the workbox.

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

GET v1r1_workbox_messages{message_id}_receipt_status

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/messages/{message_id}/receipt_status", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/messages/{message_id}/receipt_status

Returns the workbox message receipt status for each participant

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none

Example responses

200 Response

[
  {
    "user_id": 0,
    "received": true,
    "read": true
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the message receipt status Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_message_participant_receipt_status] false none none
» user_id integer(int32) false none none
» received boolean false none Whether or not this message is received by the participant
» read boolean false none Whether or not this message is read by the participant

GET _v1r2_workbox_messages

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r2/workbox/messages \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r2/workbox/messages HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r2/workbox/messages',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r2/workbox/messages', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r2/workbox/messages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r2/workbox/messages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r2/workbox/messages

Get paginated list of messages for a workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.
after query string false Cursor for start of the results to return

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "deleted": true,
      "deleted_at": "string",
      "edited": true,
      "edited_at": "string",
      "id": 0,
      "internal": true,
      "metadata": "string",
      "read": true,
      "sent_at": "string",
      "type": "string",
      "user": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "user_name": "string",
      "uuid": "string",
      "version": 0,
      "workbox_id": 0,
      "root_id": -1,
      "root_message": {
        "deleted": true,
        "deleted_at": "string",
        "edited": true,
        "edited_at": "string",
        "id": 0,
        "internal": true,
        "metadata": "string",
        "read": true,
        "sent_at": "string",
        "type": "string",
        "user": {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "location": "string",
          "name": "string",
          "title": "string",
          "username": "string"
        },
        "user_name": "string",
        "uuid": "string",
        "version": 0,
        "workbox_id": 0
      },
      "parent_id": -1,
      "reply_count": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning message results in subsequent calls
» entries [workbox_messageV1R2] false none none
»» deleted boolean false none none
»» deleted_at string false none none
»» edited boolean false none none
»» edited_at string false none none
»» id integer false none ID of the message in the workbox
»» internal boolean false none Whether or not this is an internal message
»» metadata string false none JSON data for the message, includes the message content
»» read boolean false none Whether or not the message has been read by you
»» sent_at string false none none
»» type string false none Type of the message
»» user brief_contact false none none
»»» avatar avatarV1 false none none
»»»» full string false none URL to full-size avatar
»»»» thumb string false none URL avatar thumbnail
»»» id integer(int32) false none ID of the user
»»» location string false none none
»»» name string false none none
»»» title string false none none
»»» username string false none none
»» user_name string false none Human readable name of the user who sent the message
»» uuid string false none none
»» version integer false none none
»» workbox_id integer false none ID of the workbox
»» root_id integer false none ID of the root message
»» root_message workbox_message false none none
»»» deleted boolean false none none
»»» deleted_at string false none none
»»» edited boolean false none none
»»» edited_at string false none none
»»» id integer false none ID of the message in the workbox
»»» internal boolean false none Whether or not this is an internal message
»»» metadata string false none JSON data for the message, includes the message content
»»» read boolean false none Whether or not the message has been read by you
»»» sent_at string false none none
»»» type string false none Type of the message
»»» user brief_contact false none none
»»» user_name string false none Human readable name of the user who sent the message
»»» uuid string false none none
»»» version integer false none none
»»» workbox_id integer false none ID of the workbox
»» parent_id integer false none ID of the parent message
»» reply_count integer false none root message reply count

POST _v1r2_workbox_messages

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r2/workbox/messages \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r2/workbox/messages HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "internal": true,
  "metadata": {},
  "sent_at": "string",
  "type": "Text",
  "username": "string",
  "uuid": "string",
  "version": 2
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r2/workbox/messages',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r2/workbox/messages', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r2/workbox/messages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r2/workbox/messages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r2/workbox/messages

Send a workbox message

Body parameter

{
  "internal": true,
  "metadata": {},
  "sent_at": "string",
  "type": "Text",
  "username": "string",
  "uuid": "string",
  "version": 2
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» internal body boolean false Whether or not this is an internal message
» metadata body object true JSON metadata for the content of the message
» sent_at body string false ISO8601 formatted timestamp when the message was sent, defaults to current time
» type body string true The type of message
» username body string true Human readable name
» uuid body string false Client-side generated UUID to identify the message, defaults to random UUID.
» version body integer false Optional, version of the workbox message, defaults to 2

Enumerated Values

Parameter Value
» type Text
» type QRMessage
» type Image
» type Video
» type Audio
» type Document
» type ProcedureState
» version 2
» version 1

Example responses

200 Response

{
  "deleted": true,
  "deleted_at": "string",
  "edited": true,
  "edited_at": "string",
  "id": 0,
  "internal": true,
  "metadata": "string",
  "read": true,
  "sent_at": "string",
  "type": "string",
  "user": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "user_name": "string",
  "uuid": "string",
  "version": 0,
  "workbox_id": 0,
  "root_id": -1,
  "root_message": {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0
  },
  "parent_id": -1,
  "reply_count": 0
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox message that was created workbox_messageV1R2
400 Bad Request A generic error response errorV1R1

GET _v1r2_workbox_messages_history_by_direction

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r2/workbox/messages/history_by_direction", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r2/workbox/messages/history_by_direction

Returns 'limit' messages before or after provided message ID

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id query integer(int32) false The ID to return messages before or after
direction query string false Either ASC or DESC, returns messages in ascending or descending order by sent_at timestamp
limit query integer(int32) false Maximum number of results to return. Defaults -1, return server configured amount.

Example responses

200 Response

[
  {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0,
    "root_id": -1,
    "root_message": {
      "deleted": true,
      "deleted_at": "string",
      "edited": true,
      "edited_at": "string",
      "id": 0,
      "internal": true,
      "metadata": "string",
      "read": true,
      "sent_at": "string",
      "type": "string",
      "user": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "user_name": "string",
      "uuid": "string",
      "version": 0,
      "workbox_id": 0
    },
    "parent_id": -1,
    "reply_count": 0
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_messageV1R2] false none none
» deleted boolean false none none
» deleted_at string false none none
» edited boolean false none none
» edited_at string false none none
» id integer false none ID of the message in the workbox
» internal boolean false none Whether or not this is an internal message
» metadata string false none JSON data for the message, includes the message content
» read boolean false none Whether or not the message has been read by you
» sent_at string false none none
» type string false none Type of the message
» user brief_contact false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none ID of the user
»» location string false none none
»» name string false none none
»» title string false none none
»» username string false none none
» user_name string false none Human readable name of the user who sent the message
» uuid string false none none
» version integer false none none
» workbox_id integer false none ID of the workbox
» root_id integer false none ID of the root message
» root_message workbox_message false none none
»» deleted boolean false none none
»» deleted_at string false none none
»» edited boolean false none none
»» edited_at string false none none
»» id integer false none ID of the message in the workbox
»» internal boolean false none Whether or not this is an internal message
»» metadata string false none JSON data for the message, includes the message content
»» read boolean false none Whether or not the message has been read by you
»» sent_at string false none none
»» type string false none Type of the message
»» user brief_contact false none none
»» user_name string false none Human readable name of the user who sent the message
»» uuid string false none none
»» version integer false none none
»» workbox_id integer false none ID of the workbox
» parent_id integer false none ID of the parent message
» reply_count integer false none root message reply count

GET _v1r2_workbox_messages_recent_history

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r2/workbox/messages/recent_history \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r2/workbox/messages/recent_history HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/recent_history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r2/workbox/messages/recent_history',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r2/workbox/messages/recent_history', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r2/workbox/messages/recent_history', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/recent_history");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r2/workbox/messages/recent_history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r2/workbox/messages/recent_history

Returns 'limit' recent message history

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.

Example responses

200 Response

[
  {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0,
    "root_id": -1,
    "root_message": {
      "deleted": true,
      "deleted_at": "string",
      "edited": true,
      "edited_at": "string",
      "id": 0,
      "internal": true,
      "metadata": "string",
      "read": true,
      "sent_at": "string",
      "type": "string",
      "user": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "user_name": "string",
      "uuid": "string",
      "version": 0,
      "workbox_id": 0
    },
    "parent_id": -1,
    "reply_count": 0
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_messageV1R2] false none none
» deleted boolean false none none
» deleted_at string false none none
» edited boolean false none none
» edited_at string false none none
» id integer false none ID of the message in the workbox
» internal boolean false none Whether or not this is an internal message
» metadata string false none JSON data for the message, includes the message content
» read boolean false none Whether or not the message has been read by you
» sent_at string false none none
» type string false none Type of the message
» user brief_contact false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none ID of the user
»» location string false none none
»» name string false none none
»» title string false none none
»» username string false none none
» user_name string false none Human readable name of the user who sent the message
» uuid string false none none
» version integer false none none
» workbox_id integer false none ID of the workbox
» root_id integer false none ID of the root message
» root_message workbox_message false none none
»» deleted boolean false none none
»» deleted_at string false none none
»» edited boolean false none none
»» edited_at string false none none
»» id integer false none ID of the message in the workbox
»» internal boolean false none Whether or not this is an internal message
»» metadata string false none JSON data for the message, includes the message content
»» read boolean false none Whether or not the message has been read by you
»» sent_at string false none none
»» type string false none Type of the message
»» user brief_contact false none none
»» user_name string false none Human readable name of the user who sent the message
»» uuid string false none none
»» version integer false none none
»» workbox_id integer false none ID of the workbox
» parent_id integer false none ID of the parent message
» reply_count integer false none root message reply count

GET _v1r2_workbox_messages_updates_since

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r2/workbox/messages/updates_since \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r2/workbox/messages/updates_since HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/updates_since',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r2/workbox/messages/updates_since',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r2/workbox/messages/updates_since', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r2/workbox/messages/updates_since', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/updates_since");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r2/workbox/messages/updates_since", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r2/workbox/messages/updates_since

Returns 'limit' messages since provided timestamp

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
timestamp query string false The time after which to return messages, as an ISO8601 formatted timestamp
limit query integer(int32) false Maximum number of results to return. Defaults -1, return server configured amount.

Example responses

200 Response

[
  {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0,
    "root_id": -1,
    "root_message": {
      "deleted": true,
      "deleted_at": "string",
      "edited": true,
      "edited_at": "string",
      "id": 0,
      "internal": true,
      "metadata": "string",
      "read": true,
      "sent_at": "string",
      "type": "string",
      "user": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "user_name": "string",
      "uuid": "string",
      "version": 0,
      "workbox_id": 0
    },
    "parent_id": -1,
    "reply_count": 0
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_messageV1R2] false none none
» deleted boolean false none none
» deleted_at string false none none
» edited boolean false none none
» edited_at string false none none
» id integer false none ID of the message in the workbox
» internal boolean false none Whether or not this is an internal message
» metadata string false none JSON data for the message, includes the message content
» read boolean false none Whether or not the message has been read by you
» sent_at string false none none
» type string false none Type of the message
» user brief_contact false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none ID of the user
»» location string false none none
»» name string false none none
»» title string false none none
»» username string false none none
» user_name string false none Human readable name of the user who sent the message
» uuid string false none none
» version integer false none none
» workbox_id integer false none ID of the workbox
» root_id integer false none ID of the root message
» root_message workbox_message false none none
»» deleted boolean false none none
»» deleted_at string false none none
»» edited boolean false none none
»» edited_at string false none none
»» id integer false none ID of the message in the workbox
»» internal boolean false none Whether or not this is an internal message
»» metadata string false none JSON data for the message, includes the message content
»» read boolean false none Whether or not the message has been read by you
»» sent_at string false none none
»» type string false none Type of the message
»» user brief_contact false none none
»» user_name string false none Human readable name of the user who sent the message
»» uuid string false none none
»» version integer false none none
»» workbox_id integer false none ID of the workbox
» parent_id integer false none ID of the parent message
» reply_count integer false none root message reply count

DELETE v1r2_workbox_messages{message_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r2/workbox/messages/{message_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r2/workbox/messages/{message_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r2/workbox/messages/{message_id}

Delete message from existing workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Returns true None
400 Bad Request A generic error response errorV1R1

GET v1r2_workbox_messages{message_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r2/workbox/messages/{message_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r2/workbox/messages/{message_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r2/workbox/messages/{message_id}

Get a workbox message by id

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer true Workbox message ID

Example responses

200 Response

{
  "deleted": true,
  "deleted_at": "string",
  "edited": true,
  "edited_at": "string",
  "id": 0,
  "internal": true,
  "metadata": "string",
  "read": true,
  "sent_at": "string",
  "type": "string",
  "user": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "user_name": "string",
  "uuid": "string",
  "version": 0,
  "workbox_id": 0,
  "root_id": -1,
  "root_message": {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0
  },
  "parent_id": -1,
  "reply_count": 0
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox message workbox_messageV1R2
400 Bad Request A generic error response errorV1R1

PUT v1r2_workbox_messages{message_id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r2/workbox/messages/{message_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r2/workbox/messages/{message_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "metadata": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r2/workbox/messages/{message_id}

Edits message in existing workbox

Body parameter

{
  "metadata": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none
body body object true none
» metadata body string false JSON string of the new metadata for the message

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Returns true None
400 Bad Request A generic error response errorV1R1

POST v1r2_workbox_messages{message_id}_last_read_message

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/last_read_message", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r2/workbox/messages/{message_id}/last_read_message

Set the last read message for a user in a workbox. Use -1 or 0 for message_id to indicate the most recent message in the workbox.

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

GET v1r2_workbox_messages{message_id}_receipt_status

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/receipt_status", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r2/workbox/messages/{message_id}/receipt_status

Returns the workbox message receipt status for each participant

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true none

Example responses

200 Response

[
  {
    "user_id": 0,
    "received": true,
    "read": true
  }
]

Responses

Status Meaning Description Schema
200 OK success, returns the message receipt status Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [workbox_message_participant_receipt_status] false none none
» user_id integer(int32) false none none
» received boolean false none Whether or not this message is received by the participant
» read boolean false none Whether or not this message is read by the participant

GET v1r2_workbox_messages{message_id}_replies

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r2/workbox/messages/{message_id}/replies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r2/workbox/messages/{message_id}/replies

Get paginated list of messages for replies

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
message_id path integer(int32) true The root message id to get replies for
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.
after query string false Cursor for start of the results to return

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "deleted": true,
      "deleted_at": "string",
      "edited": true,
      "edited_at": "string",
      "id": 0,
      "internal": true,
      "metadata": "string",
      "read": true,
      "sent_at": "string",
      "type": "string",
      "user": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "user_name": "string",
      "uuid": "string",
      "version": 0,
      "workbox_id": 0,
      "root_id": -1,
      "root_message": {
        "deleted": true,
        "deleted_at": "string",
        "edited": true,
        "edited_at": "string",
        "id": 0,
        "internal": true,
        "metadata": "string",
        "read": true,
        "sent_at": "string",
        "type": "string",
        "user": {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "location": "string",
          "name": "string",
          "title": "string",
          "username": "string"
        },
        "user_name": "string",
        "uuid": "string",
        "version": 0,
        "workbox_id": 0
      },
      "parent_id": -1,
      "reply_count": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK success, returns the messages Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning message results in subsequent calls
» entries [workbox_messageV1R2] false none none
»» deleted boolean false none none
»» deleted_at string false none none
»» edited boolean false none none
»» edited_at string false none none
»» id integer false none ID of the message in the workbox
»» internal boolean false none Whether or not this is an internal message
»» metadata string false none JSON data for the message, includes the message content
»» read boolean false none Whether or not the message has been read by you
»» sent_at string false none none
»» type string false none Type of the message
»» user brief_contact false none none
»»» avatar avatarV1 false none none
»»»» full string false none URL to full-size avatar
»»»» thumb string false none URL avatar thumbnail
»»» id integer(int32) false none ID of the user
»»» location string false none none
»»» name string false none none
»»» title string false none none
»»» username string false none none
»» user_name string false none Human readable name of the user who sent the message
»» uuid string false none none
»» version integer false none none
»» workbox_id integer false none ID of the workbox
»» root_id integer false none ID of the root message
»» root_message workbox_message false none none
»»» deleted boolean false none none
»»» deleted_at string false none none
»»» edited boolean false none none
»»» edited_at string false none none
»»» id integer false none ID of the message in the workbox
»»» internal boolean false none Whether or not this is an internal message
»»» metadata string false none JSON data for the message, includes the message content
»»» read boolean false none Whether or not the message has been read by you
»»» sent_at string false none none
»»» type string false none Type of the message
»»» user brief_contact false none none
»»» user_name string false none Human readable name of the user who sent the message
»»» uuid string false none none
»»» version integer false none none
»»» workbox_id integer false none ID of the workbox
»» parent_id integer false none ID of the parent message
»» reply_count integer false none root message reply count

PUT _v1r1_workbox_participants

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/workbox/participants \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/workbox/participants HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "coworker_ids": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/participants',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/workbox/participants',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/workbox/participants', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/workbox/participants', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/participants");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/workbox/participants", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/workbox/participants

Sets coworkers in an existing workbox

Body parameter

{
  "coworker_ids": 0
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» coworker_ids body integer(int32) false IDs of the users to set in the workbox, must be in the same enterprise.

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK The modified workbox workbox
400 Bad Request A generic error response errorV1R1

POST _v1r1_workbox_procedure

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/procedure \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/procedure HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "action_time": "string",
  "offline": true,
  "owner_id": 0,
  "procedure_id": 0,
  "procedure_version": 0,
  "state": "string",
  "task_uuid": "string",
  "values_url": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/procedure',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/procedure',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/procedure', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/procedure', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/procedure");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/procedure", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/procedure

Add procedure to a workbox

Body parameter

{
  "action_time": "string",
  "offline": true,
  "owner_id": 0,
  "procedure_id": 0,
  "procedure_version": 0,
  "state": "string",
  "task_uuid": "string",
  "values_url": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» action_time body string false procedure action time with iso8601 format
» offline body boolean false procedure offine available or not
» owner_id body number false owner id of procedure in workbox
» procedure_id body number false procedure id
» procedure_version body number false procedure version
» state body string false procedure state
» task_uuid body string false Workbox procedure task uuid
» values_url body string false procedure url

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

PUT _v1r1_workbox_procedure

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/workbox/procedure \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/workbox/procedure HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "action_time": "string",
  "id": 0,
  "state": "string",
  "task_uuid": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/procedure',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/workbox/procedure',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/workbox/procedure', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/workbox/procedure', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/procedure");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/workbox/procedure", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/workbox/procedure

Update procedure in a workbox

Body parameter

{
  "action_time": "string",
  "id": 0,
  "state": "string",
  "task_uuid": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» action_time body string false procedure action time with iso8601 format
» id body number false workbox procedure linked id(not procedure id)
» state body string false procedure state
» task_uuid body string false workbox procedure linked task uuid

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

POST _v1r1_workbox_reopen

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/reopen \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/reopen HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/reopen',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/reopen',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/reopen', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/reopen', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/reopen");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/reopen", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/reopen

Reopens a workbox

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

POST _v1r1_workbox_session

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/session \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/session HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "participant_ids": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/session',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/session',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/session', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/session', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/session");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/session", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/session

Create a session in a workbox

Body parameter

{
  "participant_ids": [
    0
  ]
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» participant_ids body [integer] true IDs for participants to include as owners in the session

Example responses

200 Response

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "active": true,
      "enterprise_id": 0,
      "id": "string",
      "name": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Responses

Status Meaning Description Schema
200 OK success, returns the session sessionV1R1
400 Bad Request A generic error response errorV1R1

PUT _v1r1_workbox_title

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/workbox/title \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/workbox/title HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "title": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/title',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/workbox/title',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/workbox/title', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/workbox/title', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/title");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/workbox/title", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/workbox/title

Sets the workbox title

Body parameter

{
  "title": "string"
}

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
body body object true none
» title body string false New title of the workbox.

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK The modified workbox workbox
400 Bad Request A generic error response errorV1R1

POST _v1r1_workbox_report

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workbox/report \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workbox/report HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/report',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workbox/report',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workbox/report', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workbox/report', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workbox/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workbox/report

Generate a report of workbox messages

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success report_uuid
400 Bad Request A generic error response errorV1R1

POST v1r1_workbox_report{report_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workbox/report/{report_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workbox/report/{report_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workbox/report/{report_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workbox/report/{report_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workbox/report/{report_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workbox/report/{report_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workbox/report/{report_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workbox/report/{report_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workbox/report/{report_id}

Get the report of workbox messages

Parameters

Name In Type Required Description
authorization header string true A workbox authorization token
report_id path string true report id

Example responses

200 Response

[
  {
    "inserted_at": "2019-08-24T14:15:22Z",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "url": "string",
    "uuid": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success report_statuses
400 Bad Request A generic error response errorV1R1

GET _v1r1_workboxes

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workboxes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workboxes

Get paginated list of workboxes for a user by status

Parameters

Name In Type Required Description
authorization header string true A user authorization token
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.
after query string false Cursor for start of the results to return
status query string false Status, can be ALL, OPEN, REPORTED, ASSIGNED or CLOSED, defaults to ALL
filter query string false Filters resources based on key, value and an inequality

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "assigned_at": "string",
      "closed_at": "string",
      "created_by": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "description": "string",
      "fields": [
        {}
      ],
      "guests": [
        {
          "has_joined": true,
          "id": 0,
          "last_read_message_id": 0,
          "name": "string",
          "unread_count": 0,
          "uuid": "string"
        }
      ],
      "queues": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "assigned_to": {
        "id": 0,
        "name": "string"
      },
      "id": 0,
      "inserted_at": "string",
      "last_active_at": "string",
      "last_read_message_id": 0,
      "participants": [
        {
          "accepted_at": "string",
          "assigned": true,
          "creator": true,
          "has_participated": true,
          "id": 0,
          "important": true,
          "name": "string",
          "removed": true
        }
      ],
      "procedureCount": 0,
      "procedures": [
        {}
      ],
      "reported_at": "string",
      "status": "string",
      "ticketFieldsFull": [
        {}
      ],
      "token": "string",
      "unread_messages_count": 0,
      "updated_at": "string",
      "version": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK success, returns the workboxes Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning workbox results in subsequent calls
» entries [workbox] false none none
»» assigned_at string false none none
»» closed_at string false none none
»» created_by brief_contact false none none
»»» avatar avatarV1 false none none
»»»» full string false none URL to full-size avatar
»»»» thumb string false none URL avatar thumbnail
»»» id integer(int32) false none ID of the user
»»» location string false none none
»»» name string false none none
»»» title string false none none
»»» username string false none none
»» description string false none none
»» fields [object] false none workbox custom fields
»» guests [workbox_guest] false none none
»»» has_joined boolean false none none
»»» id integer(int32) false none none
»»» last_read_message_id integer(int32) false none none
»»» name string false none none
»»» unread_count integer(int32) false none none
»»» uuid string false none none
»» queues [object] false none none
»»» id integer(int32) false none none
»»» name string false none none
»» assigned_to object false none none
»»» id integer(int32) false none none
»»» name string false none none
»» id integer(int32) false none The unique workbox ID
»» inserted_at string false none none
»» last_active_at string false none none
»» last_read_message_id integer(int32) false none none
»» participants [workbox_participant] false none none
»»» accepted_at string false none none
»»» assigned boolean false none Whether or not the associated workbox is assigned to this participant
»»» creator boolean false none Whether or not this user is the initial creator of the workbox
»»» has_participated boolean false none none
»»» id integer(int32) false none ID of the participant in the session (NOT the user id)
»»» important boolean false none Whether or not the user marked the associated workbox as important
»»» name string false none none
»»» removed boolean false none Whether or not this user was removed from the workbox
»» procedureCount number false none workbox procedures which does not deleted
»» procedures [object] false none workbox procedures
»» reported_at string false none none
»» status string false none Status of the workbox, may be REPORTED, ASSIGNED or CLOSED
»» ticketFieldsFull [object] false none workspace custom fields
»» token string false none A JWT used to manipulate the workbox
»» unread_messages_count integer(int32) false none none
»» updated_at string false none none
»» version string false none The version of the workbox

POST _v1r1_workboxes

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/workboxes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/workboxes HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "participant_ids": [
    0
  ],
  "title": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workboxes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/workboxes

Create a new workbox

Body parameter

{
  "participant_ids": [
    0
  ],
  "title": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» participant_ids body [integer] true List of participant IDs to include in the workbox
» title body string false Optional title of the new workbox, defaults to empty string

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK The new workbox workbox
400 Bad Request A generic error response errorV1R1

GET v1r1_workboxes_by_call_id{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workboxes/by_call_id/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workboxes/by_call_id/{id}

Get a workbox by call id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path string true Call ID

Example responses

200 Response

{
  "auto_created": true,
  "owner_id": 0,
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox info structure workbox_info
400 Bad Request A generic error response errorV1R1

GET _v1r1_workboxes_by_url

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workboxes/by_url?link_url=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workboxes/by_url?link_url=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workboxes/by_url?link_url=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workboxes/by_url',
  params: {
  'link_url' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workboxes/by_url', params={
  'link_url': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workboxes/by_url', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workboxes/by_url?link_url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workboxes/by_url", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workboxes/by_url

Get a workbox by url

Parameters

Name In Type Required Description
authorization header string true A user authorization token
link_url query string true The full workbox invite link, including the signature

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

GET _v1r1_workboxes_info

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workboxes/info \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workboxes/info HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workboxes/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workboxes/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workboxes/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workboxes/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workboxes/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workboxes/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workboxes/info

Get information about the user's workboxes

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "closed": 0,
  "last_active_at": "string",
  "open": 0,
  "total": 0,
  "unread_count_closed": 0,
  "unread_count_open": 0,
  "unread_count_total": 0
}

Responses

Status Meaning Description Schema
200 OK success, returns workboxes info workboxes_info
400 Bad Request A generic error response errorV1R1

GET v1r1_workboxes{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/workboxes/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/workboxes/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/workboxes/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/workboxes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/workboxes/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/workboxes/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/workboxes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/workboxes/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/workboxes/{id}

Get a workbox by id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true Workbox ID

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

User-Level: Aliases

Alias Management

GET _v1r1_user_workspaces

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/workspaces \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/workspaces HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/workspaces',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/workspaces',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/workspaces', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/workspaces', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/workspaces");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/workspaces", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/workspaces

Get a list of our workspaces

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "workspace_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK List of our workspaces Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [user_workspace] false none none
» id integer(int32) false none The user alias ID
» name string false none The name of workspaces
» workspace_id integer(int32) false none The workspace ID

GET v1r1_user_workspaces{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/user/workspaces/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/user/workspaces/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/user/workspaces/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/user/workspaces/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/user/workspaces/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/user/workspaces/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/user/workspaces/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/user/workspaces/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/user/workspaces/{id}

Obtain authorization tokens for a workspace via user alias id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
id path integer true user alias id corresponding to the workspace you want to authorize

Example responses

200 Response

{
  "refresh": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Authorization successful, authorization token is returned in the body refresh_tokenV1
400 Bad Request A generic error response errorV1R1

User-Level: Queues

Help Thread Queues

paginate_user_queues

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/queues \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/queues HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/queues',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/queues',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/queues', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/queues', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/queues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/queues", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/queues

Paginate through all the workbox queues for a user

Parameters

Name In Type Required Description
authorization header string true A user authorization token
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor for the page to return
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "id": "string",
      "enterprise_id": "string",
      "name": "string",
      "description": "string",
      "unassigned_workboxes_count": 0,
      "open_workboxes_count": 0,
      "updated_at": "string",
      "inserted_at": "string"
    }
  ],
  "after": "string",
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of queues user_queue_page
400 Bad Request A generic error response errorV1R1

paginate_user_queues_workboxes

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/queues/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/queues/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/queues/workboxes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/queues/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/queues/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/queues/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/queues/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/queues/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/queues/workboxes

Paginate through all workboxes in every queue for a user.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor to retrieve results from, optional
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "priority": "string",
      "assigned": true,
      "assigned_to": "string",
      "updated_at": "string",
      "inserted_at": "string",
      "workbox": {
        "assigned_at": "string",
        "closed_at": "string",
        "created_by": {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "location": "string",
          "name": "string",
          "title": "string",
          "username": "string"
        },
        "description": "string",
        "fields": [
          {}
        ],
        "guests": [
          {
            "has_joined": true,
            "id": 0,
            "last_read_message_id": 0,
            "name": "string",
            "unread_count": 0,
            "uuid": "string"
          }
        ],
        "queues": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "assigned_to": {
          "id": 0,
          "name": "string"
        },
        "id": 0,
        "inserted_at": "string",
        "last_active_at": "string",
        "last_read_message_id": 0,
        "participants": [
          {
            "accepted_at": "string",
            "assigned": true,
            "creator": true,
            "has_participated": true,
            "id": 0,
            "important": true,
            "name": "string",
            "removed": true
          }
        ],
        "procedureCount": 0,
        "procedures": [
          {}
        ],
        "reported_at": "string",
        "status": "string",
        "ticketFieldsFull": [
          {}
        ],
        "token": "string",
        "unread_messages_count": 0,
        "updated_at": "string",
        "version": "string"
      },
      "queue_id": 0
    }
  ],
  "after": "string",
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of queued workboxes queued_workbox_page
400 Bad Request A generic error response errorV1R1

get_user_queue_id

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/queues/{queue_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/queues/{queue_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/queues/{queue_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/queues/{queue_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/queues/{queue_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/queues/{queue_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/queues/{queue_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/queues/{queue_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/queues/{queue_id}

Get a workbox queue by id

Parameters

Name In Type Required Description
authorization header string true A user authorization token
queue_id path integer true Queue ID

Example responses

200 Response

{
  "id": "string",
  "enterprise_id": "string",
  "name": "string",
  "description": "string",
  "unassigned_workboxes_count": 0,
  "open_workboxes_count": 0,
  "updated_at": "string",
  "inserted_at": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the queue user_queue
400 Bad Request A generic error response errorV1R1

paginate_user_queues_workboxes_by_queue

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/queues/{queue_id}/workboxes

Paginate through workboxes in a queue

Parameters

Name In Type Required Description
authorization header string true A user authorization token
queue_id path integer true Queue ID
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor to retrieve results from, optional
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "priority": "string",
      "assigned": true,
      "assigned_to": "string",
      "updated_at": "string",
      "inserted_at": "string",
      "workbox": {
        "assigned_at": "string",
        "closed_at": "string",
        "created_by": {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "location": "string",
          "name": "string",
          "title": "string",
          "username": "string"
        },
        "description": "string",
        "fields": [
          {}
        ],
        "guests": [
          {
            "has_joined": true,
            "id": 0,
            "last_read_message_id": 0,
            "name": "string",
            "unread_count": 0,
            "uuid": "string"
          }
        ],
        "queues": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "assigned_to": {
          "id": 0,
          "name": "string"
        },
        "id": 0,
        "inserted_at": "string",
        "last_active_at": "string",
        "last_read_message_id": 0,
        "participants": [
          {
            "accepted_at": "string",
            "assigned": true,
            "creator": true,
            "has_participated": true,
            "id": 0,
            "important": true,
            "name": "string",
            "removed": true
          }
        ],
        "procedureCount": 0,
        "procedures": [
          {}
        ],
        "reported_at": "string",
        "status": "string",
        "ticketFieldsFull": [
          {}
        ],
        "token": "string",
        "unread_messages_count": 0,
        "updated_at": "string",
        "version": "string"
      },
      "queue_id": 0
    }
  ],
  "after": "string",
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of queued workboxes queued_workbox_page
400 Bad Request A generic error response errorV1R1

get_user_queues_workbox_by_id

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/queues/{queue_id}/workboxes/{workbox_id}

Get information about a single queued workbox in a queue.

Parameters

Name In Type Required Description
authorization header string true A user authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

assign_workbox_to_yourself

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/assign", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/queues/{queue_id}/workboxes/{workbox_id}/assign

Assign a workbox to yourself

Parameters

Name In Type Required Description
authorization header string true A user authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

unassign_workbox_from_yourself

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/queues/{queue_id}/workboxes/{workbox_id}/unassign", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/queues/{queue_id}/workboxes/{workbox_id}/unassign

Unassign a workbox from yourself, putting it back in the queue

Parameters

Name In Type Required Description
authorization header string true A user authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

User-Level: Miscellaneous

Miscellanouse User APIs

POST _v1_diagnostic_upload

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/diagnostic/upload \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/diagnostic/upload HTTP/1.1
Host: api.helplightning.net
Content-Type: application/octet-stream
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/diagnostic/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/octet-stream',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/diagnostic/upload',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/octet-stream',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/diagnostic/upload', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/octet-stream',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/diagnostic/upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/diagnostic/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/octet-stream"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/diagnostic/upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/diagnostic/upload

Uploads a file for the user. This is stored on S3

Body parameter

string

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body string(binary) true none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE _v1_file

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/file \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/file HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/file',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/file',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/file', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/file', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/file", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/file

Deletes file

Parameters

Name In Type Required Description
authorization header string true A file authorization token

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful deletion of file None
401 Unauthorized Unauthorized, login credentials invalid errorV1

GET _v1_file

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/file \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/file HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/file',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/file',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/file', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/file', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/file", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/file

Gets information about a file

Parameters

Name In Type Required Description
authorization header string true A file authorization token

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success, returns info about a file string
401 Unauthorized Unauthorized, login credentials invalid errorV1

PUT _v1_file

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/file \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/file HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/file',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/file',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/file', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/file', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/file", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/file

Overwrites file with new data

Parameters

Name In Type Required Description
authorization header string true A file authorization token

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success, returns info of updated file resource string
401 Unauthorized Unauthorized, login credentials invalid errorV1

GET _v1_languages

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/languages \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/languages HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/languages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/languages',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/languages', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/languages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/languages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/languages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/languages

Return a database of supported languages

Parameters

Name In Type Required Description
authorization header string true A user authorization token

Example responses

200 Response

{
  "en_US": "English (United States)",
  "fr_FR": "French (France)",
  "es_ES": "Spanish (Spain)",
  "de_DE": "German (Germany)",
  "zh_CN": "Chinese (Simplified)"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a map of supported languages Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Map of language codes to their full names

Name Type Required Restrictions Description
» additionalProperties string false none Full language name

Enterprise-Level: Audit Logs

Audit Log APIs

GET _v1_enterprise_audit_logs

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/audit_logs \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/audit_logs HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/audit_logs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/audit_logs',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/audit_logs', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/audit_logs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/audit_logs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/audit_logs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/audit_logs

Get the audit logs

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

[
  {
    "action_noun": "string",
    "action_verb": "string",
    "app_id": "string",
    "enterprise": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "2019-08-24T14:15:22Z",
    "ip_address": "string",
    "objects": [
      {
        "id": "string",
        "type": "string"
      }
    ],
    "subject": {
      "id": "string",
      "name": "string"
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Success AuditLogList
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Enterprise-Level: Enterprise Management

Enterprise Info and Management

GET _v1_enterprise_info

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/info \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/info HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/info

Gets information about the enterprise.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "active": true,
  "active_user_count": 0,
  "auto_accept": true,
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "description": "string",
  "domains": [
    "string"
  ],
  "id": 0,
  "lock_devices": true,
  "max_users": "string",
  "name": "string",
  "time_zone": "string",
  "token": "string",
  "translation_file_url": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns enterprise information map. enterpriseV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT _v1_enterprise_info

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/info HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "active": true,
  "auto_accept": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "description": "string",
  "domains": [
    "string"
  ],
  "max_users": "string",
  "name": "string",
  "time_zone": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/info',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/info

Sets information about the enterprise.

Body parameter

{
  "active": true,
  "auto_accept": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "description": "string",
  "domains": [
    "string"
  ],
  "max_users": "string",
  "name": "string",
  "time_zone": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» active body boolean false Whether or not the enterprise account is active for use
» auto_accept body boolean false Whether or not to auto-accept invitations to domains.
» contact_email body string false Enterprise contact email
» contact_name body string false Enterprise contact name
» contact_phone body string false Enterprise contact phone number
» description body string false The enterprise's description.
» domains body [string] false List of approved domains owned by this enterprise for auto-accept.
» max_users body string false Maximum allowed users in the enterprise
» name body string false Name of the enterprise
» time_zone body string false Enterprise's time zone

Example responses

200 Response

{
  "active": true,
  "active_user_count": 0,
  "auto_accept": true,
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "description": "string",
  "domains": [
    "string"
  ],
  "id": 0,
  "lock_devices": true,
  "max_users": "string",
  "name": "string",
  "time_zone": "string",
  "token": "string",
  "translation_file_url": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns enterprise information map. enterpriseV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_invitations

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/invitations \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/invitations HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/invitations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/invitations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/invitations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/invitations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/invitations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/invitations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/invitations

Gets enterprise's outgoing invitations.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "email": "string",
      "enterprise_name": "string",
      "id": 0,
      "invitation_sent_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "personas": [
        "string"
      ],
      "pods": [
        "string"
      ],
      "status": "string",
      "user_exists": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a list of enterprise invitations as a map. invitations
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_invitations{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/invitations/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/invitations/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/invitations/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/invitations/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/invitations/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/invitations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/invitations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/invitations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/invitations/{id}

Gets an enterprise invitation.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Invitation ID

Example responses

200 Response

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "personas": [
    "string"
  ],
  "pods": [
    "string"
  ],
  "status": "string",
  "user_exists": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns an enterprise invitation as a map. enterprise_invitationV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_invitations{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/invitations/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/invitations/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "action": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/invitations/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/invitations/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/invitations/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/invitations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/invitations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/invitations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/invitations/{id}

Updates an enterprise invitation.

Body parameter

{
  "action": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Invitation ID
body body object true Action to take on the enterprise invitation
» action body string true Action to take, may be 'revoke', or 'accept_email_change'

Example responses

200 Response

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "personas": [
    "string"
  ],
  "pods": [
    "string"
  ],
  "status": "string",
  "user_exists": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns an enterprise invitation as a map. enterprise_invitationV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST v1_enterprise_invitations{id}_resend_confirmation

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/invitations/{id}/resend_confirmation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/invitations/{id}/resend_confirmation

Resends the invitation email

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Invitation email sent None
401 Unauthorized Unauthorized, confirmation email not sent errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_one_time_link

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/one_time_link \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/one_time_link HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/one_time_link',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/one_time_link',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/one_time_link', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/one_time_link', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/one_time_link");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/one_time_link", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/one_time_link

Get one time link configuration for enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0
}

Responses

Status Meaning Description Schema
200 OK one time link information Inline
401 Unauthorized Unauthorized, not a enterprise admin errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» session_link_expiration_hours integer(int32) false none none
» session_link_max_lifetime_days integer(int32) false none none

PUT _v1_enterprise_one_time_link

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/one_time_link \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/one_time_link HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/one_time_link',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/one_time_link',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/one_time_link', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/one_time_link', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/one_time_link");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/one_time_link", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/one_time_link

Set one time link configuration for enterprise

Body parameter

{
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» session_link_expiration_hours body integer true one time link expired hours after clicked
» session_link_max_lifetime_days body integer true one time link expired days when not clicked

Example responses

200 Response

{
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0
}

Responses

Status Meaning Description Schema
200 OK one time link information Inline
401 Unauthorized Unauthorized, not a enterprise admin errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» session_link_expiration_hours integer(int32) false none none
» session_link_max_lifetime_days integer(int32) false none none

GET _v1_enterprise_roles

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/roles \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/roles HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/roles',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/roles', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/roles

Gets all available roles

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "default_role": true,
      "hr_name": "string",
      "name": "string",
      "permissions": [
        {
          "description": "string",
          "hr_name": "string",
          "name": "string"
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of role information roles
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_roles{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/roles/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/roles/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/roles/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/roles/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/roles/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/roles/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/roles/{id}

Gets information about a role

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Role ID

Example responses

200 Response

{
  "default_role": true,
  "hr_name": "string",
  "name": "string",
  "permissions": [
    {
      "description": "string",
      "hr_name": "string",
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about the role role
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_subscription

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/subscription \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/subscription HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/subscription',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/subscription',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/subscription', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/subscription', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/subscription");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/subscription", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/subscription

Gets enterprise subscription information

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "active": true,
  "billing_day": 0,
  "canceled_at": "string",
  "card_last4": "string",
  "card_type": "string",
  "delinquent": true,
  "delinquent_at": "string",
  "id": 0,
  "mobile_users": 0,
  "monthly_base_cost": 0.1,
  "subscription_end": "string",
  "trial_end": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns enterprise subscription subscriptionV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_subscription_plan

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/subscription/plan \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/subscription/plan HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/subscription/plan',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/subscription/plan',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/subscription/plan', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/subscription/plan', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/subscription/plan");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/subscription/plan", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/subscription/plan

Gets enterprise plan information

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "color": "string",
  "cost_per_user": 0.1,
  "description": "string",
  "featured": "string",
  "id": 0,
  "long_name": "string",
  "max_minutes": 0,
  "max_users": 0,
  "name": "string",
  "plan_type": "string",
  "price": 0.1
}

Responses

Status Meaning Description Schema
200 OK Success, returns enterprise plan planV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_translations

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/translations \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/translations HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/translations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/translations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/translations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/translations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/translations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/translations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/translations

Gets enterprise translations.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "items": [
      {
        "language_iso": "string",
        "translation": "string"
      }
    ],
    "key_name": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns an enterprise translations as a list. enterprise_translation
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_enterprise_translations_upload

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/translations/upload \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/translations/upload HTTP/1.1
Host: api.helplightning.net
Content-Type: multipart/form-data
Accept: application/json
authorization: string


const inputBody = '{
  "lang_iso": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/translations/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/translations/upload',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/translations/upload', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/translations/upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/translations/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/translations/upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/translations/upload

Upload csv format translation file

Body parameter

lang_iso: string

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object true none
» lang_iso body string true The language iso of csv file

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success, returns info of updated file resource string
401 Unauthorized Unauthorized, login credentials invalid errorV1

PUT v1_enterprise_translations{key_name}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/translations/{key_name} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/translations/{key_name} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '[
  {
    "language_iso": "string",
    "translation": "string"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/translations/{key_name}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/translations/{key_name}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/translations/{key_name}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/translations/{key_name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/translations/{key_name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/translations/{key_name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/translations/{key_name}

Update translation key

Body parameter

[
  {
    "language_iso": "string",
    "translation": "string"
  }
]

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
key_name path string true Key name
body body array[object] true translations for a key

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success, returns info of updated file resource string
401 Unauthorized Unauthorized, login credentials invalid errorV1

GET _v1r1_enterprise

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise

Gets information about the enterprise.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "auto_accept": true,
  "aws_credentials": {
    "access_key_id": "string",
    "cloudfront_url": "string",
    "s3_bucket": "string",
    "s3_cookie_expiration": 0,
    "s3_cookie_key_id": "string",
    "s3_cookie_policy": "string",
    "s3_cookie_signature": "string",
    "s3_organization_base_path": "string",
    "s3_region": "string",
    "secret_access_key": "string",
    "session_token": "string"
  },
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "default_pod_id": 0,
  "delete_users_upon_declination_of_disclaimer": true,
  "description": "string",
  "disable_agent_camera_in_call_center_mode": true,
  "domain": {
    "company": "string",
    "id": 0,
    "mailbag": "string",
    "mode": "string",
    "name": "string",
    "standard": true
  },
  "domains": [
    "string"
  ],
  "expert_on_call_notification_email": "string",
  "features": [
    {
      "description": "string",
      "id": 0,
      "name": "string",
      "var": "string"
    }
  ],
  "id": 0,
  "name": "string",
  "password_policy": {
    "password_required_description": "string",
    "rules": [
      {
        "regex": "string",
        "required": "string",
        "text": "string",
        "type": "string"
      }
    ]
  },
  "recording_retention_days": 0,
  "retention_policy_days": 0,
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0,
  "subscription": {
    "active": true,
    "billing_day": 0,
    "canceled_at": "string",
    "card_last4": "string",
    "card_type": "string",
    "delinquent": true,
    "delinquent_at": "string",
    "id": 0,
    "mobile_users": 0,
    "monthly_base_cost": 0.1,
    "subscription_end": "string",
    "trial_end": "string"
  },
  "survey_url": "string",
  "time_zone": "string",
  "translation_file_url": "string",
  "user_count": 0,
  "watermark_enabled": true,
  "workbox_enabled": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns enterprise information map. enterpriseV1R1
400 Bad Request A generic error response errorV1R1

PUT _v1r1_enterprise

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "active": true,
  "auto_accept": true,
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "default_pod_id": 0,
  "delete_users_upon_declination_of_disclaimer": true,
  "description": "string",
  "disable_agent_camera_in_call_center_mode": true,
  "domain_id": 0,
  "domains": [
    "string"
  ],
  "expert_on_call_notification_email": "string",
  "features": [
    0
  ],
  "name": "string",
  "plan_id": 0,
  "recording_retention_days": 0,
  "retention_policy_days": 0,
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0,
  "survey_url": "string",
  "time_zone": "string",
  "watermark_enabled": true,
  "workbox_enabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise

Sets information about the enterprise.

Body parameter

{
  "active": true,
  "auto_accept": true,
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "default_pod_id": 0,
  "delete_users_upon_declination_of_disclaimer": true,
  "description": "string",
  "disable_agent_camera_in_call_center_mode": true,
  "domain_id": 0,
  "domains": [
    "string"
  ],
  "expert_on_call_notification_email": "string",
  "features": [
    0
  ],
  "name": "string",
  "plan_id": 0,
  "recording_retention_days": 0,
  "retention_policy_days": 0,
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0,
  "survey_url": "string",
  "time_zone": "string",
  "watermark_enabled": true,
  "workbox_enabled": true
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» active body boolean false Whether or not the enterprise is active.
» auto_accept body boolean false Whether or not to auto-accept invitations to domains.
» branding_locked body boolean false Whether or not to allow branding to become enabled, admin-only
» contact_email body string false Enterprise contact email
» contact_name body string false Enterprise contact name
» contact_phone body string false Enterprise contact phone number
» default_pod_id body integer(int32) false The default pod id
» delete_users_upon_declination_of_disclaimer body boolean false Whether or not delete the user, based on declination of disclaimer
» description body string false Enterprise's description
» disable_agent_camera_in_call_center_mode body boolean false Whether or not to disable the camera in call center mode
» domain_id body integer(int32) false Domain ID for this enterprise. Only admins can set this.
» domains body [string] false List of approved domains owned by this enterprise for auto-accept.
» expert_on_call_notification_email body string false Sets the email for the notification about no one on call for the enterprise
» features body [integer] false List of additional features for this enterprise. Only admins can set this
» name body string false Name of the enterprise
» plan_id body integer(int32) false The new plan ID for the enterprise. Only admins can set this
» recording_retention_days body integer(int32) false How many days to retain call data
» retention_policy_days body integer(int32) false How many days to retain call data
» session_link_expiration_hours body integer(int32) false one time link expired hours after clicked
» session_link_max_lifetime_days body integer(int32) false one time link expired days when not clicked
» survey_url body string false The enterprise's survey_url.
» time_zone body string false Enterprise's time zone
» watermark_enabled body boolean false Whether or not to disable the watermark in call
» workbox_enabled body boolean false Whether or not to disable the workbox in workspace

Example responses

200 Response

{
  "auto_accept": true,
  "aws_credentials": {
    "access_key_id": "string",
    "cloudfront_url": "string",
    "s3_bucket": "string",
    "s3_cookie_expiration": 0,
    "s3_cookie_key_id": "string",
    "s3_cookie_policy": "string",
    "s3_cookie_signature": "string",
    "s3_organization_base_path": "string",
    "s3_region": "string",
    "secret_access_key": "string",
    "session_token": "string"
  },
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "default_pod_id": 0,
  "delete_users_upon_declination_of_disclaimer": true,
  "description": "string",
  "disable_agent_camera_in_call_center_mode": true,
  "domain": {
    "company": "string",
    "id": 0,
    "mailbag": "string",
    "mode": "string",
    "name": "string",
    "standard": true
  },
  "domains": [
    "string"
  ],
  "expert_on_call_notification_email": "string",
  "features": [
    {
      "description": "string",
      "id": 0,
      "name": "string",
      "var": "string"
    }
  ],
  "id": 0,
  "name": "string",
  "password_policy": {
    "password_required_description": "string",
    "rules": [
      {
        "regex": "string",
        "required": "string",
        "text": "string",
        "type": "string"
      }
    ]
  },
  "recording_retention_days": 0,
  "retention_policy_days": 0,
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0,
  "subscription": {
    "active": true,
    "billing_day": 0,
    "canceled_at": "string",
    "card_last4": "string",
    "card_type": "string",
    "delinquent": true,
    "delinquent_at": "string",
    "id": 0,
    "mobile_users": 0,
    "monthly_base_cost": 0.1,
    "subscription_end": "string",
    "trial_end": "string"
  },
  "survey_url": "string",
  "time_zone": "string",
  "translation_file_url": "string",
  "user_count": 0,
  "watermark_enabled": true,
  "workbox_enabled": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns enterprise information map. enterpriseV1R1
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_call_tags

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/call_tags \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/call_tags HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/call_tags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/call_tags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/call_tags', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/call_tags', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/call_tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/call_tags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/call_tags

Gets all of the tags for the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, get tags for the enterprise and returns info about it Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [call_tag] false none none
» id integer(int32) false none Call tag identifier
» name string false none tag name

POST _v1r1_enterprise_call_tags

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/call_tags \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/call_tags HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/call_tags',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/call_tags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/call_tags', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/call_tags', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/call_tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/call_tags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/call_tags

creates a new call tag in the enterprise

Body parameter

"string"

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body string true none

Example responses

200 Response

{
  "id": 0,
  "name": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, creates tag in enterprise call_tag
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_call_tags{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/call_tags/{id}

Deletes a call tag in an enterprise by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true tag id

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK Success success
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_call_tags{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/call_tags/{id}

Gets a call tag in an enterprise by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true tag id

Example responses

200 Response

{
  "id": 0,
  "name": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a tag call_tag
400 Bad Request A generic error response errorV1R1

PUT v1r1_enterprise_call_tags{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/call_tags/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/call_tags/{id}

Sets a call tag in an enterprise by id

Body parameter

"string"

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true tag id
body body string true none

Example responses

200 Response

{
  "id": 0,
  "name": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a tag call_tag
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_disclaimer

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/disclaimer \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/disclaimer HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/disclaimer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/disclaimer',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/disclaimer', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/disclaimer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/disclaimer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/disclaimer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/disclaimer

Get disclaimer text of an enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "delete_users_upon_declination_of_disclaimer": true,
  "enabled": true,
  "text": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise users enterprise_disclaimer
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_disclaimer_reset

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/disclaimer/reset", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/disclaimer/reset

Reset the disclaimer_accepted value of all users in a enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_features

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/features \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/features HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/features',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/features',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/features', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/features', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/features");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/features", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/features

Gets all of the avaliable features for the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "enabled": true,
    "name": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of features features
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_features

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/features \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/features HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "enable": true,
  "feature": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/features',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/features',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/features', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/features', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/features");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/features", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/features

enable or disable a feature for the enterprise

Body parameter

{
  "enable": true,
  "feature": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» enable body boolean false Enable or disable a feature.
» feature body string false Feature

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_invitations

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/invitations \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/invitations HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/invitations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/invitations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/invitations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/invitations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/invitations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/invitations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/invitations

Gets enterprise's outgoing invitations.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "email": "string",
      "enterprise_name": "string",
      "id": 0,
      "invitation_sent_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "personas": [
        "string"
      ],
      "pods": [
        "string"
      ],
      "status": "string",
      "user_exists": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a list of enterprise invitations as a map. enterprise_invitations
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_invitations{invitation_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/invitations/{invitation_id}

Gets an enterprise invitation.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
invitation_id path integer true Invitation ID

Example responses

200 Response

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "location": "string",
  "manage": true,
  "name": "string",
  "pods": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "user_exists": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns an enterprise invitation as a map. enterprise_invitationV1R1
400 Bad Request A generic error response errorV1R1

PUT v1r1_enterprise_invitations{invitation_id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}?action=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}?action=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}?action=string',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}',
  params: {
  'action' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}', params={
  'action': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}?action=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/invitations/{invitation_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/invitations/{invitation_id}

Updates an enterprise invitation.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
invitation_id path integer true Invitation ID
action query string true Action to take, may be 'revoke', 'resend', or 'accept_email_change'

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

DELETE _v1r1_enterprise_strings

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/strings?key=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/strings?key=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/strings?key=string',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/strings',
  params: {
  'key' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/strings', params={
  'key': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/strings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/strings?key=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/strings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/strings

Deletes a string from the enterprise strings map

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
key query string true the string's key

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, string deleted None
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_strings

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/strings \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/strings HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/strings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/strings',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/strings', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/strings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/strings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/strings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/strings

Gets a map of all strings for an enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a list of enterprise strings as a map. None
400 Bad Request A generic error response errorV1R1

PUT _v1r1_enterprise_strings

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/strings?key=string&value=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/strings?key=string&value=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/strings?key=string&value=string',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/strings',
  params: {
  'key' => 'string',
'value' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/strings', params={
  'key': 'string',  'value': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/strings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/strings?key=string&value=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/strings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/strings

Update the value of a string for an enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
key query string true the string's key
value query string true the string's value

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a map of the updated enterprise strings None
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_workspace_call_tags

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workspace/call_tags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workspace/call_tags

Get a list of all call tags in this enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "workspace_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of call tags Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [enterprise_workspace_call_tag] false none none
» id integer(int32) false none Call tag identifier
» name string false none tag name
» workspace_id integer(int32) false none The workspace ID

Enterprise-Level: Extension Management

Enterprise Api Keys, Webhooks, and developer tools

GET _v1r1_enterprise_api_keys

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/api_keys \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/api_keys HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/api_keys',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/api_keys',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/api_keys', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/api_keys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/api_keys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/api_keys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/api_keys

Get the apikeys

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "access_token": "string",
      "description": "string",
      "id": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of apikeys enterprise_apikeys
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_api_keys

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/api_keys \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/api_keys HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/api_keys',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/api_keys',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/api_keys', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/api_keys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/api_keys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/api_keys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/api_keys

Create a new apikey

Body parameter

{
  "description": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» description body string true A description of the apikey

Example responses

200 Response

{
  "access_token": "string",
  "description": "string",
  "id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, the new apikey enterprise_apikey
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_api_keys{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/api_keys/{id}

Delete an apikey

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true apikey id

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_api_keys{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/api_keys/{id}

Get an apikey by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true apikey id

Example responses

200 Response

{
  "access_token": "string",
  "description": "string",
  "id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, the apikey enterprise_apikey
400 Bad Request A generic error response errorV1R1

PUT v1r1_enterprise_api_keys{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/api_keys/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/api_keys/{id}

Update an apikey

Body parameter

{
  "description": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true apikey id
body body object true none
» description body string false The apikey's new description

Example responses

200 Response

{
  "access_token": "string",
  "description": "string",
  "id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, the apikey enterprise_apikey
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_partner_key

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/partner_key \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/partner_key HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/partner_key',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/partner_key',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/partner_key', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/partner_key', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/partner_key");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/partner_key", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/partner_key

Get the public key associated with our partner key

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "message": {
    "created_at": "2019-08-24T14:15:22Z",
    "description": "string",
    "enterprise_id": 0,
    "public_key": "string"
  },
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Success, partner key enterprise_partner_public_key
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_partner_key

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/partner_key \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/partner_key HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/partner_key',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/partner_key',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/partner_key', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/partner_key', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/partner_key");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/partner_key", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/partner_key

Create a new private/public partner key pair

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "message": {
    "private": "string",
    "public": "string"
  },
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Sucess, private/public key pair enterprise_partner_key
400 Bad Request A generic error response errorV1R1

PUT _v1r1_enterprise_partner_key

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/partner_key \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/partner_key HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/partner_key',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/partner_key',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/partner_key', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/partner_key', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/partner_key");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/partner_key", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/partner_key

Replace the partner key with a new public key

Body parameter

"string"

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body string true none

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_partner_keys

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/partner_keys \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/partner_keys HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/partner_keys',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/partner_keys',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/partner_keys', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/partner_keys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/partner_keys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/partner_keys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/partner_keys

Get all public keys associated with our enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "success": true,
    "message": {
      "id": 0,
      "enterprise_id": 0,
      "public_key": "string",
      "private_key": "string",
      "description": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of partner keys Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [enterprise_partner_public_key2] false none none
» success boolean false none Whether the operation was successful
» message object false none none
»» id integer false none The partner key ID
»» enterprise_id integer false none The enterprise id
»» public_key string false none The PEM encoded public key
»» private_key string false none The PEM encoded private key (Only returned upon creation)
»» description string false none The description
»» created_at string(date-time) false none none

POST _v1r1_enterprise_partner_keys

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/partner_keys \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/partner_keys HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/partner_keys',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/partner_keys',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/partner_keys', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/partner_keys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/partner_keys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/partner_keys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/partner_keys

Generate and return a new private/public partner key pair

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "success": true,
  "message": {
    "id": 0,
    "enterprise_id": 0,
    "public_key": "string",
    "private_key": "string",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Sucess, private/public key pair enterprise_partner_public_key2
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_partner_keys{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/partner_keys/{id}

Delete an existing partner key by its ID

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true partner key id

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

PUT v1r1_enterprise_partner_keys{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "description": "string",
  "public_key": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/partner_keys/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/partner_keys/{id}

Replace the partner key with a new public key

Body parameter

{
  "description": "string",
  "public_key": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true partner key id
body body object true none
» description body string false The partner_key's new description
» public_key body string false PEM encoded RSA Public Key?

Example responses

200 Response

{
  "success": true,
  "message": {
    "id": 0,
    "enterprise_id": 0,
    "public_key": "string",
    "private_key": "string",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Success, key information enterprise_partner_public_key2
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_webhooks

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/webhooks \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/webhooks HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/webhooks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/webhooks',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/webhooks', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/webhooks', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/webhooks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/webhooks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/webhooks

Get the webhooks

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "event": "string",
      "event_filter": "string",
      "id": 0,
      "webhook": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of webhooks enterprise_webhooks
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_webhooks

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/webhooks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/webhooks HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "event": "string",
  "event_filter": "string",
  "secret": "string",
  "webhook": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/webhooks',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/webhooks',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/webhooks', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/webhooks', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/webhooks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/webhooks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/webhooks

Create a new webhook

Body parameter

{
  "event": "string",
  "event_filter": "string",
  "secret": "string",
  "webhook": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» event body string true The event to register a webhook for
» event_filter body string false A regex of subevents to filter out
» secret body string false A secret
» webhook body string true The URL of the webhook that the event will be posted to. This MUST be an https secure site!

Example responses

200 Response

{
  "event": "string",
  "event_filter": "string",
  "id": 0,
  "webhook": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, the new webhook enterprise_webhook
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_webhooks{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/webhooks/{id}

Delete a webhook

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true tag id

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_webhooks{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/webhooks/{id}

Get a webhook by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true tag id

Example responses

200 Response

{
  "event": "string",
  "event_filter": "string",
  "id": 0,
  "webhook": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, the new webhook enterprise_webhook
400 Bad Request A generic error response errorV1R1

PUT v1r1_enterprise_webhooks{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "event_filter": "string",
  "secret": "string",
  "webhook": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/webhooks/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/webhooks/{id}

Update a webhook

Body parameter

{
  "event_filter": "string",
  "secret": "string",
  "webhook": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true tag id
body body object true none
» event_filter body string false A regex of subevents to filter out
» secret body string false A secret
» webhook body string false The URL of the webhook that the event will be posted to. This MUST be an https secure site!

Example responses

200 Response

{
  "event": "string",
  "event_filter": "string",
  "id": 0,
  "webhook": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, the new webhook enterprise_webhook
400 Bad Request A generic error response errorV1R1

Enterprise-Level: User Management

Enterprise User Info and Management

GET _v1_enterprise_users

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/users \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/users HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/users

Gets all enterprise users

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "available": "string",
      "avatar": "string",
      "confirmed_email": true,
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "permissions": [
        "string"
      ],
      "personal_room_session_id": "string",
      "personal_room_url": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise users users
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_enterprise_users

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "adminPodIds": [
    0
  ],
  "email": "string",
  "name": "string",
  "password": "string",
  "personaIds": [
    0
  ],
  "podIds": [
    0
  ],
  "role": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/users

Invites a user to the enterprise

Body parameter

{
  "adminPodIds": [
    0
  ],
  "email": "string",
  "name": "string",
  "password": "string",
  "personaIds": [
    0
  ],
  "podIds": [
    0
  ],
  "role": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» adminPodIds body [integer] false IDs of admin pods to add user into.
» email body string true Email or username of user to invite
» name body string true Full name of the user to invite.
» password body string false Password to set for a new user with an email that is in the enterprise domains list.
» personaIds body [integer] true IDs of personas to add user into.
» podIds body [integer] true IDs of pods to add user into.
» role body string true Role ID of user to add

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, user invited None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_users_pods_personas

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/users/pods_personas \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/users/pods_personas HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users/pods_personas',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/users/pods_personas',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/users/pods_personas', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/users/pods_personas', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users/pods_personas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/users/pods_personas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/users/pods_personas

Gets all enterprise user pods and personas in a map

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "available": "string",
      "avatar": "string",
      "confirmed_email": true,
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "permissions": [
        "string"
      ],
      "personal_room_session_id": "string",
      "personal_room_url": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, map of pods and personas for each user users
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_users{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/users/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/users/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/users/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/users/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/users/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/users/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/users/{id}

Removes user from enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true User ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, user removed from enterprise None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_users{id}_info

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/users/{id}/info \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/users/{id}/info HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users/{id}/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/users/{id}/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/users/{id}/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/users/{id}/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users/{id}/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/users/{id}/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/users/{id}/info

Gets information about a user

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer(int32) true ID of user in the enterprise

Example responses

200 Response

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about the user user
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_users{id}_info

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/users/{id}/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/users/{id}/info HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "active": true,
  "name": "string",
  "personas": [
    0
  ],
  "pods": [
    0
  ],
  "role": "string",
  "username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users/{id}/info',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/users/{id}/info',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/users/{id}/info', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/users/{id}/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users/{id}/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/users/{id}/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/users/{id}/info

Updates enterprise related properties of the user

Body parameter

{
  "active": true,
  "name": "string",
  "personas": [
    0
  ],
  "pods": [
    0
  ],
  "role": "string",
  "username": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer(int32) true User ID
body body object true none
» active body boolean false Whether or not user account is active and able to make calls
» name body string false New display name of the user
» personas body [integer] false Array of persona IDs. If specified this replaces the user's personas.
» pods body [integer] false Array of pods IDs. If specified this replaces the user's pods.
» role body string false Role to assign (see GET /enterprise/roles for allowable values)
» username body string false New username of the user

Example responses

200 Response

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, user updated user
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_users{id}_personas

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/users/{id}/personas \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/users/{id}/personas HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users/{id}/personas',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/users/{id}/personas',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/users/{id}/personas', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/users/{id}/personas', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users/{id}/personas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/users/{id}/personas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/users/{id}/personas

Gets a list of persona names that a user is in

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer(int32) true ID of user in the enterprise

Example responses

200 Response

[
  "string"
]

Responses

Status Meaning Description Schema
200 OK Success, returns list of personasf Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

GET v1_enterprise_users{id}_pods

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/users/{id}/pods \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/users/{id}/pods HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users/{id}/pods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/users/{id}/pods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/users/{id}/pods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/users/{id}/pods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users/{id}/pods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/users/{id}/pods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/users/{id}/pods

Gets a list of pod names that a user is in

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer(int32) true ID of user in the enterprise

Example responses

200 Response

[
  "string"
]

Responses

Status Meaning Description Schema
200 OK Success, returns list of pods Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

GET _v1r1_enterprise_group_admins

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/group_admins \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/group_admins HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/group_admins',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/group_admins',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/group_admins', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/group_admins', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/group_admins");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/group_admins", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/group_admins

Gets all of the group admins within an enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "admin_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "appliance_registration_status": false,
      "available": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "current_sign_in_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "email_confirmed": true,
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "license": "string",
      "name": "string",
      "parent_id": 0,
      "permissions": [
        "string"
      ],
      "phone": "string",
      "pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "provider": "string",
      "provider_uid": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "username": "string",
      "visible_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "workspaces": [
        {
          "id": 0,
          "name": "string",
          "workspace_id": 0
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise users enterprise_users
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_impersonate{user_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/impersonate/{user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/impersonate/{user_id}

Impersonate another user in your enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
user_id path integer(int32) true ID of user in the enterprise
add_permissions query array[string] false List of additional permissions to add to the token
remove_permissions query array[string] false List of permissions to remove from the token

Example responses

200 Response

{
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about the user tokenV1
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_search_users

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/search/users \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/search/users HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/search/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/search/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/search/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/search/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/search/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/search/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/search/users

Searches for users in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
search_term query string false Text search term
active query boolean false Whether to return active or inactive users
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "admin_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "appliance_registration_status": false,
      "available": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "current_sign_in_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "email_confirmed": true,
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "license": "string",
      "name": "string",
      "parent_id": 0,
      "permissions": [
        "string"
      ],
      "phone": "string",
      "pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "provider": "string",
      "provider_uid": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "username": "string",
      "visible_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "workspaces": [
        {
          "id": 0,
          "name": "string",
          "workspace_id": 0
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise users enterprise_users
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_users

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/users \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/users HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/users

Gets all enterprise users

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "admin_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "appliance_registration_status": false,
      "available": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "current_sign_in_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "email_confirmed": true,
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "license": "string",
      "name": "string",
      "parent_id": 0,
      "permissions": [
        "string"
      ],
      "phone": "string",
      "pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "provider": "string",
      "provider_uid": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "username": "string",
      "visible_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "workspaces": [
        {
          "id": 0,
          "name": "string",
          "workspace_id": 0
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise users enterprise_users
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_users

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "admin_pod_ids": [
    0
  ],
  "email": "string",
  "invite": true,
  "license": "expert",
  "location": "",
  "name": "string",
  "password": "string",
  "phone": "",
  "pod_ids": [
    0
  ],
  "role": "string",
  "send_email": true,
  "title": ""
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/users

Invites a user to the enterprise

Body parameter

{
  "admin_pod_ids": [
    0
  ],
  "email": "string",
  "invite": true,
  "license": "expert",
  "location": "",
  "name": "string",
  "password": "string",
  "phone": "",
  "pod_ids": [
    0
  ],
  "role": "string",
  "send_email": true,
  "title": ""
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» admin_pod_ids body [integer] false IDs of admin pods to add user into.
» email body string true Email or username of user to invite
» invite body boolean false Send an invitation instead of creating the user directly
» license body string false License to use for the user, can be expert, team, or bot
» location body string false Location of the contact
» name body string true Full name of the user to invite.
» password body string false Password to set for a new user with an email that is in the enterprise domains list.
» phone body string false Mobile phone number of the user. Must be in E.164 format
» pod_ids body [integer] false IDs of pods to add user into.
» role body string false Role name for user
» send_email body boolean false Whether or not to send an email to the new users. If they are invited, the email is always sent
» title body string false Title of the contact

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_users{user_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/users/{user_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/users/{user_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/users/{user_id}

Permanently removes user from enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
user_id path integer true User ID

Example responses

401 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, user removed from enterprise None
401 Unauthorized A generic error response errorV1R1
500 Internal Server Error A generic error response errorV1R1

GET v1r1_enterprise_users{user_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/users/{user_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/users/{user_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/users/{user_id}

Gets information about a user

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
user_id path integer(int32) true ID of user in the enterprise

Example responses

200 Response

{
  "active": true,
  "admin_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "appliance_registration_status": false,
  "available": true,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "current_sign_in_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "email_confirmed": true,
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "name": "string",
  "parent_id": 0,
  "permissions": [
    "string"
  ],
  "phone": "string",
  "pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "provider": "string",
  "provider_uid": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "username": "string",
  "visible_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "id": 0,
      "name": "string",
      "workspace_id": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about the user enterprise_user
400 Bad Request A generic error response errorV1R1

PUT v1r1_enterprise_users{user_id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/users/{user_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/users/{user_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "active": true,
  "admin_pod_ids": [
    0
  ],
  "license": "expert",
  "location": "",
  "name": "string",
  "on_call": true,
  "phone": "",
  "pod_ids": [
    0
  ],
  "role": "string",
  "title": "",
  "username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/users/{user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/users/{user_id}

Updates enterprise related properties of the user

Body parameter

{
  "active": true,
  "admin_pod_ids": [
    0
  ],
  "license": "expert",
  "location": "",
  "name": "string",
  "on_call": true,
  "phone": "",
  "pod_ids": [
    0
  ],
  "role": "string",
  "title": "",
  "username": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
user_id path integer(int32) true User ID
body body object true none
» active body boolean false Whether or not user account is active and able to make calls
» admin_pod_ids body [integer] false Array of pods IDs that the user can administer.
» license body string false License to use for the user, can be expert or team
» location body string false Location of the contact
» name body string false New display name of the user
» on_call body boolean false Whether or not user account is on call. This only applies to users that are members of an expert group
» phone body string false Phone number of user
» pod_ids body [integer] false Array of pods IDs. If specified this replaces the user's pods.
» role body string false Role to assign (see GET /enterprise/roles for allowable values)
» title body string false Title of the contact
» username body string false New username of the user

Example responses

200 Response

{
  "active": true,
  "admin_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "appliance_registration_status": false,
  "available": true,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "current_sign_in_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "email_confirmed": true,
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "name": "string",
  "parent_id": 0,
  "permissions": [
    "string"
  ],
  "phone": "string",
  "pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "provider": "string",
  "provider_uid": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "username": "string",
  "visible_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "id": 0,
      "name": "string",
      "workspace_id": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, user updated enterprise_user
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Appliance Management

Enterprise Appliance Info and Management

GET _v1r1_enterprise_appliances

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/appliances \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/appliances HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/appliances',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/appliances',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/appliances', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/appliances', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/appliances");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/appliances", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/appliances

Gets all enterprise appliances

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "admin_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "appliance_registration_status": false,
      "available": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "current_sign_in_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "email_confirmed": true,
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "license": "string",
      "name": "string",
      "parent_id": 0,
      "permissions": [
        "string"
      ],
      "phone": "string",
      "pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "provider": "string",
      "provider_uid": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "username": "string",
      "visible_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "workspaces": [
        {
          "id": 0,
          "name": "string",
          "workspace_id": 0
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise appliances enterprise_users
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_appliances

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/appliances \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/appliances HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "location": "",
  "name": "string",
  "phone": "",
  "pod_ids": [
    0
  ],
  "title": ""
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/appliances',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/appliances',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/appliances', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/appliances', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/appliances");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/appliances", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/appliances

Add an appliance to the enterprise

Body parameter

{
  "location": "",
  "name": "string",
  "phone": "",
  "pod_ids": [
    0
  ],
  "title": ""
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» location body string false Location of the contact
» name body string true Full name of the user to invite.
» phone body string false Mobile phone number of the user. Must be in E.164 format
» pod_ids body [integer] false IDs of pods to add user into.
» title body string false Title of the contact

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_appliances_registration_status

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status?uuid=string \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status?uuid=string HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status?uuid=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status',
  params: {
  'uuid' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status', params={
  'uuid': 'string'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status?uuid=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/appliances/registration_status", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/appliances/registration_status

Get the status of a registration

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
uuid query string true The registration uuid

Example responses

200 Response

{
  "status": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise appliances registration_status
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_appliances{appliance_id}_register

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/appliances/{appliance_id}/register

Deletes the registration of a device.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
appliance_id path integer true The appliance id

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, deletes the registration of a device. None
400 Bad Request A generic error response errorV1R1

POST v1r1_enterprise_appliances{appliance_id}_register

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "pin": ""
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/appliances/{appliance_id}/register", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/appliances/{appliance_id}/register

Register an appliance

Body parameter

{
  "pin": ""
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
appliance_id path integer true The appliance id
body body object true none
» pin body string true The PIN

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_search_appliances

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/search/appliances \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/search/appliances HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/search/appliances',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/search/appliances',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/search/appliances', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/search/appliances', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/search/appliances");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/search/appliances", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/search/appliances

Searches for appliances in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
search_term query string false Text search term
active query boolean false Whether to return active or inactive users
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "admin_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "appliance_registration_status": false,
      "available": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "current_sign_in_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "email_confirmed": true,
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "license": "string",
      "name": "string",
      "parent_id": 0,
      "permissions": [
        "string"
      ],
      "phone": "string",
      "pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "provider": "string",
      "provider_uid": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "username": "string",
      "visible_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "workspaces": [
        {
          "id": 0,
          "name": "string",
          "workspace_id": 0
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise appliances enterprise_users
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Persona Management

Enterprise Persona Management

GET _v1_enterprise_personas

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/personas \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/personas HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/personas',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/personas', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/personas', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/personas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/personas

Lists personas in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": "string",
      "color": "string",
      "description": "string",
      "id": 0,
      "name": "string",
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns list of personas personas
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_enterprise_personas

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/personas \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/personas HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "color": "string",
  "description": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/personas',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/personas', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/personas', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/personas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/personas

Creates a persona in the enterprise

Body parameter

{
  "color": "string",
  "description": "string",
  "name": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» color body string false Persona's color for dashboard.
» description body string false Description of the persona
» name body string false Name of the persona

Example responses

200 Response

{
  "avatar": "string",
  "color": "string",
  "description": "string",
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, creates a persona and returns info about it persona
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_personas_ids

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/personas/ids \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/personas/ids HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/ids',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/personas/ids',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/personas/ids', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/personas/ids', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/ids");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/personas/ids", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/personas/ids

Maps all persona ids to names in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a map of persona IDs (integers) to names (strings) None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_personas{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/personas/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/personas/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/personas/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/personas/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/personas/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/personas/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/personas/{id}

Deletes persona from enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_personas{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/personas/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/personas/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/personas/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/personas/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/personas/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/personas/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/personas/{id}

Gets a persona in the enterprise by ID

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID

Example responses

200 Response

{
  "avatar": "string",
  "color": "string",
  "description": "string",
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, persona information persona
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_personas{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/personas/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/personas/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "color": "string",
  "description": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/personas/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/personas/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/personas/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/personas/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/personas/{id}

Updates info about the persona

Body parameter

{
  "color": "string",
  "description": "string",
  "name": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID
body body object true none
» color body string false Persona's color for dashboard.
» description body string false Description of the persona
» name body string false Name of the persona

Example responses

200 Response

{
  "avatar": "string",
  "color": "string",
  "description": "string",
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, persona information persona
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_personas{id}_avatar

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/personas/{id}/avatar

Removes persona avatar

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, avatar removed None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_personas{id}_avatar

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/personas/{id}/avatar

Gets the persona avatar as a map of URLs

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID

Example responses

200 Response

{
  "full": "string",
  "thumb": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, avatar info returned. avatarV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_personas{id}_avatar

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar HTTP/1.1
Host: api.helplightning.net
Content-Type: application/octet-stream
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/octet-stream',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/octet-stream',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/octet-stream',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/octet-stream"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/personas/{id}/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/personas/{id}/avatar

Uploads a new persona avatar image

Body parameter

string

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID
body body string(binary) true none

Example responses

200 Response

{
  "full": "string",
  "thumb": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns avatar URL info avatarV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_personas{id}_users

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/personas/{id}/users \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/personas/{id}/users HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/personas/{id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/personas/{id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/personas/{id}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/personas/{id}/users

Gets all users in the persona

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

[
  {
    "active": true,
    "available": "string",
    "avatar": "string",
    "confirmed_email": true,
    "created_at": "2019-08-24T14:15:22Z",
    "email": "string",
    "id": 0,
    "is_confirmed": true,
    "is_first_login": true,
    "last_used_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "permissions": [
      "string"
    ],
    "personal_room_session_id": "string",
    "personal_room_url": "string",
    "role_id": 0,
    "role_name": "string",
    "status": "string",
    "status_message": "string",
    "token": "string",
    "unavailable_expires_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "username": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of user information Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [user] false none none
» active boolean false none Whether or not user account is active and able to make calls
» available string false none Available status of user (ONLINE, BUSY, IDLE).
» avatar string false none User's avatar URL
» confirmed_email boolean false none Whether or not the accounts requested email is confirmed
» created_at string(date-time) false none none
» email string false none Email of user
» id integer(int32) false none User identifier
» is_confirmed boolean false none Whether or not the user account is confirmed for login
» is_first_login boolean false none Whether or not the user has logged in for the first time
» last_used_at string(date-time) false none Last time this user account was used in the app
» name string false none Display name of user
» permissions [string] false none List of permissions for this user account
» personal_room_session_id string false none The user's personal meeting room session id if they have one. An empty string if they don't.
» personal_room_url string false none The user's personal meeting room url if they have one. An empty string if they don't.
» role_id integer false none The user's role ID
» role_name string false none The user's role
» status string false none Status of the user (Registered, Invited)
» status_message string false none Status message of contact
» token string false none Token for further actions on the contact.
» unavailable_expires_at string(date-time) false none When the unavailable status expires, as a timestamp
» updated_at string(date-time) false none none
» username string false none Username of user

POST v1_enterprise_personas{id}_users

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/personas/{id}/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/personas/{id}/users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "user_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/personas/{id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/personas/{id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/personas/{id}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/personas/{id}/users

Adds a user to this persona

Body parameter

{
  "user_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID
body body object true Adds a user to a persona
» user_id body integer(int32) false ID of user to add

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_personas{id}_users

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/personas/{id}/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/personas/{id}/users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "user_ids": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/personas/{id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/personas/{id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/personas/{id}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/personas/{id}/users

Sets the users in the persona. Users who exist in the persona but are not specified here will be removed.

Body parameter

{
  "user_ids": [
    0
  ]
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID
body body object true List of users for the persona.
» user_ids body [integer] false none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_personas{id}_users_ids

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/personas/{id}/users/ids", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/personas/{id}/users/ids

Gets all user ids in the persona as a flat list

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Persona ID

Example responses

200 Response

[
  0
]

Responses

Status Meaning Description Schema
200 OK Success, list of user ids Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

GET v1_enterprise_personas{persona_id}_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/personas/{persona_id}/calls

Gets calls made within the persona

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
persona_id path integer true Persona ID
filter query string false none
page_size query integer false none
page query integer false none
order query string false none

Example responses

200 Response

[
  {
    "alt1_id": "string",
    "alt2_id": "string",
    "alt3_id": "string",
    "callDuration": 0,
    "dialderId": "string",
    "dialer": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "dialerName": "string",
    "extra_info": "string",
    "has_attachments": true,
    "intraEnterpriseCall": true,
    "owner_email": "string",
    "owner_id": "string",
    "owner_name": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "ratings": [
      {
        "participant_id": "string",
        "rating": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiver": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "receiverId": "string",
    "receiverName": "string",
    "recordingError": "string",
    "recordingStatus": "string",
    "recordingUrl": "string",
    "session": "string",
    "tags": [
      "string"
    ],
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": "string",
    "workbox_id": 0,
    "workbox_v2_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise calls hermes_enterprise_calls
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_personas{persona_id}users{user_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/personas/{persona_id}/users/{user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/personas/{persona_id}/users/{user_id}

Removes user from persona

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
persona_id path integer true Persona ID
user_id path integer true User ID to remove

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Enterprise-Level: Group Management

Enterprise Group Management

GET _v1_enterprise_pods

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods

Lists pods in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "avatar": "string",
      "capacity": 0,
      "default": true,
      "description": "string",
      "enterprise_id": 0,
      "id": 0,
      "name": "string",
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns list of pods pods
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

POST _v1_enterprise_pods

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/pods \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/pods HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "capacity": 0,
  "description": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/pods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/pods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/pods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/pods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/pods

Creates a pod in the enterprise

Body parameter

{
  "capacity": 0,
  "description": "string",
  "name": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» capacity body integer(int32) false User capacity of the pod
» description body string false Description of the pod
» name body string false Name of the pod

Example responses

200 Response

{
  "avatar": "string",
  "capacity": 0,
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, creates a pod and returns info about it podV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_pods_default

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/default \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/default HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/default',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/default',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/default', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/default', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/default");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/default", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/default

Gets the default pod in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "avatar": "string",
  "capacity": 0,
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the default pod podV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT _v1_enterprise_pods_default

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/pods/default?pod_id=0 \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/pods/default?pod_id=0 HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/default?pod_id=0',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/pods/default',
  params: {
  'pod_id' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/pods/default', params={
  'pod_id': '0'
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/pods/default', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/default?pod_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/pods/default", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/pods/default

Sets the default pod in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id query integer(int32) true New default Pod ID

Example responses

200 Response

{
  "avatar": "string",
  "capacity": 0,
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the default pod podV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_pods_ids

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/ids \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/ids HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/ids',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/ids',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/ids', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/ids', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/ids");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/ids", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/ids

Maps all pod ids to names in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a map of pod IDs (integers) to names (strings) None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_pods{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/pods/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/pods/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/pods/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/pods/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/pods/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/pods/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/pods/{id}

Deletes pod from enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{id}

Gets a pod in the enterprise by ID

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID

Example responses

200 Response

{
  "avatar": "string",
  "capacity": 0,
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, pod information podV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_pods{id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/pods/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/pods/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "capacity": 0,
  "description": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/pods/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/pods/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/pods/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/pods/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/pods/{id}

Updates info about the pod

Body parameter

{
  "capacity": 0,
  "description": "string",
  "name": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
body body object true none
» capacity body integer(int32) false User capacity of the pod
» description body string false Description of the pod
» name body string false Name of the pod

Example responses

200 Response

{
  "avatar": "string",
  "capacity": 0,
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, pod information podV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_pods{id}_avatar

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/pods/{id}/avatar

Removes pod avatar

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, avatar removed None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{id}_avatar

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{id}/avatar

Gets the pod avatar as a map of URLs

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID

Example responses

200 Response

{
  "full": "string",
  "thumb": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, avatar info returned. avatarV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_pods{id}_avatar

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar HTTP/1.1
Host: api.helplightning.net
Content-Type: application/octet-stream
Accept: application/json
authorization: string


const inputBody = 'string';
const headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/octet-stream',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/octet-stream',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/octet-stream',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/octet-stream"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/avatar", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/pods/{id}/avatar

Uploads a new pod avatar image

Body parameter

string

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
body body string(binary) true none

Example responses

200 Response

{
  "full": "string",
  "thumb": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns avatar URL info avatarV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{id}_subpods

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{id}/subpods

Gets a pod's sub-pods

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

[
  {
    "avatar": "string",
    "capacity": 0,
    "default": true,
    "description": "string",
    "enterprise_id": 0,
    "id": 0,
    "name": "string",
    "user_count": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns information about each sub-pod in a list of maps. Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [podV1] false none none
» avatar string false none Pod's Avatar URL for dashboard.
» capacity integer(int32) false none User capacity of the pod
» default boolean false none Denotes default pod
» description string false none Description of the pod
» enterprise_id integer(int32) false none Enterprise Identifier of the pod
» id integer(int32) false none Identifier of the pod
» name string false none Name of the pod
» user_count integer(int32) false none Number of users in the pod

POST v1_enterprise_pods{id}_subpods

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '0';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/pods/{id}/subpods

Adds a subpod to the pod.

Body parameter

0

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
body body integer true Sub-pod ID

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successfully added sub-pod to pod. None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_pods{id}_subpods

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "user_ids": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/subpods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/pods/{id}/subpods

Sets the subpods of this pod

Body parameter

{
  "user_ids": [
    0
  ]
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
body body object true List of subpod IDs for the pod.
» user_ids body [integer] false none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successfully added sub-pods to pod. None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{id}_users

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/users \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/users HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{id}/users

Gets all users in the pod

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
scope query string false Scope, can be 'members' or 'explicit'. If 'members' then this method returns all users, otherwise if 'explicit' then only users in this pod are returned. Defaults to 'explicit'
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

[
  {
    "active": true,
    "available": "string",
    "avatar": "string",
    "confirmed_email": true,
    "created_at": "2019-08-24T14:15:22Z",
    "email": "string",
    "id": 0,
    "is_confirmed": true,
    "is_first_login": true,
    "last_used_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "permissions": [
      "string"
    ],
    "personal_room_session_id": "string",
    "personal_room_url": "string",
    "role_id": 0,
    "role_name": "string",
    "status": "string",
    "status_message": "string",
    "token": "string",
    "unavailable_expires_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "username": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of user information Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [user] false none none
» active boolean false none Whether or not user account is active and able to make calls
» available string false none Available status of user (ONLINE, BUSY, IDLE).
» avatar string false none User's avatar URL
» confirmed_email boolean false none Whether or not the accounts requested email is confirmed
» created_at string(date-time) false none none
» email string false none Email of user
» id integer(int32) false none User identifier
» is_confirmed boolean false none Whether or not the user account is confirmed for login
» is_first_login boolean false none Whether or not the user has logged in for the first time
» last_used_at string(date-time) false none Last time this user account was used in the app
» name string false none Display name of user
» permissions [string] false none List of permissions for this user account
» personal_room_session_id string false none The user's personal meeting room session id if they have one. An empty string if they don't.
» personal_room_url string false none The user's personal meeting room url if they have one. An empty string if they don't.
» role_id integer false none The user's role ID
» role_name string false none The user's role
» status string false none Status of the user (Registered, Invited)
» status_message string false none Status message of contact
» token string false none Token for further actions on the contact.
» unavailable_expires_at string(date-time) false none When the unavailable status expires, as a timestamp
» updated_at string(date-time) false none none
» username string false none Username of user

POST v1_enterprise_pods{id}_users

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/pods/{id}/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/pods/{id}/users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "user_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/pods/{id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/pods/{id}/users

Adds a user to this pod

Body parameter

{
  "user_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
body body object true Adds a user to a pod
» user_id body integer(int32) false ID of user to add

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_pods{id}_users

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/pods/{id}/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/pods/{id}/users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "user_ids": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/pods/{id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/pods/{id}/users

Sets the users in the pod. Users who exist in the pod but are not specified here will be removed.

Body parameter

{
  "user_ids": [
    0
  ]
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID
body body object true List of users for the pod.
» user_ids body [integer] false none

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{id}_users_ids

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{id}/users/ids", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{id}/users/ids

Gets all user ids in the pod as a flat list

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Pod ID

Example responses

200 Response

[
  0
]

Responses

Status Meaning Description Schema
200 OK Success, list of user ids Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

Response Schema

GET v1_enterprise_pods{pod_id}_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{pod_id}/calls

Gets calls made within the pod

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
filter query string false none
page_size query integer false none
page query integer false none
order query string false none

Example responses

200 Response

[
  {
    "alt1_id": "string",
    "alt2_id": "string",
    "alt3_id": "string",
    "callDuration": 0,
    "dialderId": "string",
    "dialer": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "dialerName": "string",
    "extra_info": "string",
    "has_attachments": true,
    "intraEnterpriseCall": true,
    "owner_email": "string",
    "owner_id": "string",
    "owner_name": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "ratings": [
      {
        "participant_id": "string",
        "rating": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiver": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "receiverId": "string",
    "receiverName": "string",
    "recordingError": "string",
    "recordingStatus": "string",
    "recordingUrl": "string",
    "session": "string",
    "tags": [
      "string"
    ],
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": "string",
    "workbox_id": 0,
    "workbox_v2_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise calls hermes_enterprise_calls
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{pod_id}_calls_stats

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/calls/stats", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{pod_id}/calls/stats

Gets stats about calls made within the pod

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID

Example responses

200 Response

{
  "stats": {
    "callsLastWeek": 0,
    "callsThisMonth": 0,
    "callsToday": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise calls hermes_pod_stats
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_pods{pod_id}subpods{subpod_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/pods/{pod_id}/subpods/{subpod_id}

Removes sub-pod from the pod.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
subpod_id path integer true Sub-pod ID to remove

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, sub-pod removed from pod. None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{pod_id}subpods{subpod_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/subpods/{subpod_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{pod_id}/subpods/{subpod_id}

Gets a pod's sub-pods

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
subpod_id path integer true Sub-pod ID

Example responses

200 Response

{
  "avatar": "string",
  "capacity": 0,
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "user_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about the sub-pod in a map. podV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

DELETE v1_enterprise_pods{pod_id}users{user_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/pods/{pod_id}/users/{user_id}

Removes user from pod

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
user_id path integer true User ID to remove

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_pods{pod_id}users{user_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/pods/{pod_id}/users/{user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/pods/{pod_id}/users/{user_id}

Gets a user from the pod

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
user_id path integer true User ID to remove

Example responses

200 Response

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Success user
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1r1_enterprise_pods

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/pods \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/pods HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/pods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/pods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/pods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/pods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/pods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/pods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/pods

Lists pods in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "admin_count": 0,
      "admins": [
        {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "name": "string"
        }
      ],
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "default": true,
      "description": "string",
      "enterprise_id": 0,
      "id": 0,
      "name": "string",
      "subpods": [
        {
          "id": 0,
          "manage": true,
          "name": "string"
        }
      ],
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns list of pods brief_pods
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_pods

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/pods \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/pods HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "description": "string",
  "name": "string",
  "user_license": "any"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/pods',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/pods',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/pods', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/pods', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/pods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/pods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/pods

Creates a pod in the enterprise

Body parameter

{
  "description": "string",
  "name": "string",
  "user_license": "any"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» description body string true Description of the pod
» name body string true Name of the pod
» user_license body string false The pod user license

Example responses

200 Response

{
  "admin_count": 0,
  "admins": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    }
  ],
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "subpods": [
    {
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ],
  "user_count": 0,
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, creates a pod and returns info about it podV1R1
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_pods{pod_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/pods/{pod_id}

Deletes pod from enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_pods{pod_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/pods/{pod_id}

Gets a pod in the enterprise by ID

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID

Example responses

200 Response

{
  "admin_count": 0,
  "admins": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    }
  ],
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "subpods": [
    {
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ],
  "user_count": 0,
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, pod information podV1R1
400 Bad Request A generic error response errorV1R1

PUT v1r1_enterprise_pods{pod_id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "admin_ids": [
    0
  ],
  "avatar": "string",
  "description": "string",
  "name": "string",
  "subpod_ids": [
    0
  ],
  "user_ids": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1r1/enterprise/pods/{pod_id}

Updates info about the pod

Body parameter

{
  "admin_ids": [
    0
  ],
  "avatar": "string",
  "description": "string",
  "name": "string",
  "subpod_ids": [
    0
  ],
  "user_ids": [
    0
  ]
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
body body object true none
» admin_ids body [integer] false List of new admin IDs for the pod.
» avatar body string false New avatar file for the pod
» description body string false Description of the pod
» name body string false Name of the pod
» subpod_ids body [integer] false List of new subpod IDs for the pod.
» user_ids body [integer] false List of new user IDs for the pod.

Example responses

200 Response

{
  "admin_count": 0,
  "admins": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    }
  ],
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "subpods": [
    {
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ],
  "user_count": 0,
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, pod information podV1R1
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_pods{pod_id}_users_options

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/pods/{pod_id}/users/options", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/pods/{pod_id}/users/options

Gets a list of users who can be added or removed from the pod

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none
include_all query boolean false Whether or not to include all users in the enterprise, or just the users in this pod

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "email": "string",
      "id": 0,
      "included_in_pod": true,
      "license": "string",
      "location": "string",
      "name": "string",
      "title": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of users for that can be added or removed from the pod pod_user_options
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_search_pods{pod_id}_users

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/search/pods/{pod_id}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/search/pods/{pod_id}/users

Searches for users in a pod

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
pod_id path integer true Pod ID
search_term query string false Text search term
active query boolean false Whether to return active or inactive users
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "admin_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "appliance_registration_status": false,
      "available": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "current_sign_in_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "email_confirmed": true,
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "license": "string",
      "name": "string",
      "parent_id": 0,
      "permissions": [
        "string"
      ],
      "phone": "string",
      "pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "provider": "string",
      "provider_uid": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "username": "string",
      "visible_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "workspaces": [
        {
          "id": 0,
          "name": "string",
          "workspace_id": 0
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise users enterprise_users
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_workspace_groups

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workspace/groups \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workspace/groups HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workspace/groups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workspace/groups',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workspace/groups', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workspace/groups', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workspace/groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workspace/groups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workspace/groups

Get a list of all groups in this enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "workspace_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of groups Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [enterprise_workspace_group] false none none
» id integer(int32) false none Group identifier
» name string false none group name
» workspace_id integer(int32) false none The workspace ID

Enterprise-Level: Calls & Communication

Calls at the Enterprise Level

GET _v1_enterprise_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/calls

Gets calls made within the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
filter query string false none
page_size query integer false none
page query integer false none
order query string false none

Example responses

200 Response

[
  {
    "alt1_id": "string",
    "alt2_id": "string",
    "alt3_id": "string",
    "callDuration": 0,
    "dialderId": "string",
    "dialer": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "dialerName": "string",
    "extra_info": "string",
    "has_attachments": true,
    "intraEnterpriseCall": true,
    "owner_email": "string",
    "owner_id": "string",
    "owner_name": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "ratings": [
      {
        "participant_id": "string",
        "rating": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiver": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "receiverId": "string",
    "receiverName": "string",
    "recordingError": "string",
    "recordingStatus": "string",
    "recordingUrl": "string",
    "session": "string",
    "tags": [
      "string"
    ],
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": "string",
    "workbox_id": 0,
    "workbox_v2_id": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise calls hermes_enterprise_calls
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

POST _v1_enterprise_calls

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/calls \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/calls HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "dialer_email": "string",
  "receiver_email": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/calls

Creates a call between two users in the enterprise

Body parameter

{
  "dialer_email": "string",
  "receiver_email": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» dialer_email body string true Email of enterprise user for call dialer
» receiver_email body string true Email of enterprise user for call receiver

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, dialing users None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_calls_range

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/calls/range \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/calls/range HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls/range',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/calls/range',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/calls/range', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/calls/range', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls/range");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/calls/range", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/calls/range

Gets a date range of calls made within the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
from_date query integer false Starting unix timestamp, defaults to beginning of time
to_date query integer false Ending unix timestamp, defaults to current time
page_size query integer false none
page query integer false none

Example responses

200 Response

{
  "entries": [
    {
      "alt1_id": "string",
      "alt2_id": "string",
      "alt3_id": "string",
      "callDuration": 0,
      "dialderId": "string",
      "dialer": {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "name": "string",
        "username": "string"
      },
      "dialerName": "string",
      "extra_info": "string",
      "has_attachments": true,
      "intraEnterpriseCall": true,
      "owner_email": "string",
      "owner_id": "string",
      "owner_name": "string",
      "participants": [
        {
          "email": "string",
          "enterpriseId": "string",
          "id": "string",
          "isAnonymous": true,
          "name": "string",
          "username": "string"
        }
      ],
      "ratings": [
        {
          "participant_id": "string",
          "rating": "string"
        }
      ],
      "reasonCallEnded": "string",
      "receiver": {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "name": "string",
        "username": "string"
      },
      "receiverId": "string",
      "receiverName": "string",
      "recordingError": "string",
      "recordingStatus": "string",
      "recordingUrl": "string",
      "session": "string",
      "tags": [
        "string"
      ],
      "timeCallEnded": 0,
      "timeCallStarted": 0,
      "timestamp": "string",
      "workbox_id": 0,
      "workbox_v2_id": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise calls hermes_paginated_enterprise_calls
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

GET v1_enterprise_calls{call_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/calls/{call_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/calls/{call_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/calls/{call_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/calls/{call_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls/{call_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/calls/{call_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/calls/{call_id}

Gets a call made within the enterprise by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID

Example responses

200 Response

{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "callDuration": 0,
  "dialderId": "string",
  "dialer": {
    "email": "string",
    "enterpriseId": "string",
    "id": "string",
    "name": "string",
    "username": "string"
  },
  "dialerName": "string",
  "extra_info": "string",
  "has_attachments": true,
  "intraEnterpriseCall": true,
  "owner_email": "string",
  "owner_id": "string",
  "owner_name": "string",
  "participants": [
    {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "isAnonymous": true,
      "name": "string",
      "username": "string"
    }
  ],
  "ratings": [
    {
      "participant_id": "string",
      "rating": "string"
    }
  ],
  "reasonCallEnded": "string",
  "receiver": {
    "email": "string",
    "enterpriseId": "string",
    "id": "string",
    "name": "string",
    "username": "string"
  },
  "receiverId": "string",
  "receiverName": "string",
  "recordingError": "string",
  "recordingStatus": "string",
  "recordingUrl": "string",
  "session": "string",
  "tags": [
    "string"
  ],
  "timeCallEnded": 0,
  "timeCallStarted": 0,
  "timestamp": "string",
  "workbox_id": 0,
  "workbox_v2_id": 0
}

Responses

Status Meaning Description Schema
200 OK The call hermes_call
401 Unauthorized Invalid token string
403 Forbidden Access Denied string
500 Internal Server Error Internal error errorV1

PUT v1_enterprise_calls{call_id}

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/calls/{call_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/calls/{call_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "extra_info": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/calls/{call_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/calls/{call_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls/{call_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/calls/{call_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/calls/{call_id}

Update some properties of a call within the enterprise

Body parameter

{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "extra_info": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID
body body object true none
» alt1_id body string false Alternate ID 1 (limited to 512 characters)
» alt2_id body string false Alternate ID 2 (limited to 512 characters)
» alt3_id body string false Alternate ID 3 (limited to 512 characters)
» extra_info body string false Extra Blob of data

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_calls{call_id}_event_stream

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/event_stream", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/calls/{call_id}/event_stream

Gets the event_stream log for a call

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID

Example responses

200 Response

{
  "data": {
    "from": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "is_group": true,
    "reason": "string",
    "to": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "call_id": "string",
    "event_type": "call_started",
    "participant": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "message": "string",
    "creator": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "deleted": true,
    "id": 0,
    "mime_type": "string",
    "name": "string",
    "path": "string",
    "progress": 0,
    "signed_url": "string",
    "status": "unknown",
    "thumbnail": "string",
    "timestamp": 0,
    "type": "string"
  },
  "datetime": "2019-08-24T14:15:22Z",
  "type": "request"
}

Responses

Status Meaning Description Schema
200 OK The call call_event_stream
401 Unauthorized Invalid token string
403 Forbidden Access Denied string
500 Internal Server Error Internal error errorV1

GET v1_enterprise_calls{call_id}_events

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/calls/{call_id}/events", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/calls/{call_id}/events

Gets the events log for a call

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID

Example responses

200 Response

{
  "call": {
    "callDuration": 0,
    "callId": "string",
    "dialerId": "string",
    "dialerName": "string",
    "galdrSession": "string",
    "intraEnterpriseCall": true,
    "lastEvaluatedTimestamp": 0,
    "openTokSession": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiverId": "string",
    "receiverName": "string",
    "recordingBucket": "string",
    "recordingError": "string",
    "recordingPath": "string",
    "recordingStatus": "string",
    "session": "string",
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": 0
  },
  "error": true,
  "stats": {
    "overallQuality": 0,
    "participantStats": [
      {
        "ended": {
          "appVersion": "string",
          "deviceType": "string",
          "deviceVersion": "string",
          "networkType": "string",
          "reason": "string",
          "timestamp": 0
        },
        "enterpriseId": "string",
        "id": "string",
        "isDialer": true,
        "name": "string",
        "network": {
          "avgQuality": 0,
          "avgResult": "string",
          "bandwidth": [
            {
              "audio": 0,
              "result": "string",
              "timestamp": 0,
              "video": 0
            }
          ],
          "packetLoss": [
            {
              "audio": 0,
              "result": "string",
              "timestamp": 0,
              "video": 0
            }
          ]
        },
        "started": {
          "appVersion": "string",
          "deviceType": "string",
          "deviceVersion": "string",
          "networkType": "string",
          "timestamp": 0
        }
      }
    ],
    "session": "string",
    "timestamp": 0
  }
}

Responses

Status Meaning Description Schema
200 OK The call hermes_call_event
401 Unauthorized Invalid token string
403 Forbidden Access Denied string
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_sessions

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/sessions \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/sessions HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/sessions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/sessions',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/sessions', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/sessions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/sessions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/sessions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/sessions

Gets all sessions among enterprise users

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "id": "string",
      "pin": "string",
      "token": "string",
      "updated_at": "string",
      "users": [
        {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "name": "string",
          "status": 0,
          "token": "string",
          "username": "string"
        }
      ],
      "video_active": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise sessions sessions
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_sessions{session_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/sessions/{session_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/sessions/{session_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/sessions/{session_id}

Gets all the video calls for a specific session

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
session_id path string true Session ID

Example responses

200 Response

[
  {
    "call_id": "string",
    "complete": true,
    "dialer": {
      "email": "string",
      "id": "string",
      "name": "string"
    },
    "duration": 0,
    "end_time": "2019-08-24T14:15:22Z",
    "receiver": {
      "email": "string",
      "id": "string",
      "name": "string"
    },
    "recording_status": "string",
    "recording_url": "string",
    "session_id": "string",
    "start_time": "2019-08-24T14:15:22Z",
    "successful": true
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of video calls session_calls
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET v1_enterprise_sessions{session_id}_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/sessions/{session_id}/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/sessions/{session_id}/calls

Gets all the video calls for a specific session

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
session_id path string true Session ID
from query integer false none
to query integer false none

Example responses

200 Response

[
  {
    "callDuration": 0,
    "callId": "string",
    "dialderId": "string",
    "dialerName": "string",
    "galdrSession": "string",
    "intraEnterpriseCall": true,
    "lastEvaluatedTimestamp": 0,
    "openTokSession": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiverId": "string",
    "receiverName": "string",
    "recordingBucket": "string",
    "recordingError": "string",
    "recordingPath": "string",
    "recordingStatus": "string",
    "session": "string",
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise calls Inline
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [hermes_session_call] false none none
» callDuration integer false none Duration of the call in seconds
» callId string false none none
» dialderId string false none none
» dialerName string false none none
» galdrSession string false none none
» intraEnterpriseCall boolean false none none
» lastEvaluatedTimestamp integer false none none
» openTokSession string false none none
» participants [hermes_call_participant] false none none
»» email string false none none
»» enterpriseId string false none none
»» id string false none none
»» isAnonymous boolean false none none
»» name string false none none
»» username string false none none
» reasonCallEnded string false none none
» receiverId string false none none
» receiverName string false none none
» recordingBucket string false none none
» recordingError string false none none
» recordingPath string false none none
» recordingStatus string false none none
» session string false none none
» timeCallEnded number false none none
» timeCallStarted number false none none
» timestamp string false none none

GET _v1r1_enterprise_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/calls

Gets a list of calls in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false none
filter query string false none
after query string false none
limit query integer false none

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "alt1_id": "string",
      "alt2_id": "string",
      "alt3_id": "string",
      "call_duration": 0,
      "call_id": "string",
      "dialer": {
        "email": "string",
        "enterprise_id": 0,
        "id": 0,
        "is_anonymous": true,
        "name": "string",
        "username": "string"
      },
      "extra_info": "string",
      "has_attachments": true,
      "intra_enterprise_call": true,
      "owner_email": "string",
      "owner_id": "string",
      "owner_name": "string",
      "participants": [
        {
          "email": "string",
          "enterprise_id": 0,
          "id": 0,
          "is_anonymous": true,
          "name": "string",
          "username": "string"
        }
      ],
      "reason_call_ended": "string",
      "time_call_ended": 0,
      "time_call_started": 0,
      "timestamp": "string"
    }
  ],
  "total_count": 0
}

Responses

Status Meaning Description Schema
200 OK success, returns a page of calls Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning calls in subsequent calls
» entries [enterprise_call_brief] false none none
»» alt1_id string false none none
»» alt2_id string false none none
»» alt3_id string false none none
»» call_duration integer false none Duration of the call in seconds
»» call_id string false none none
»» dialer enterprise_call_user false none none
»»» email string false none none
»»» enterprise_id integer(int32) false none none
»»» id integer(int32) false none none
»»» is_anonymous boolean false none none
»»» name string false none none
»»» username string false none none
»» extra_info string false none none
»» has_attachments boolean false none none
»» intra_enterprise_call boolean false none none
»» owner_email string false none none
»» owner_id string false none none
»» owner_name string false none none
»» participants [enterprise_call_user] false none none
»» reason_call_ended string false none none
»» time_call_ended number false none none
»» time_call_started number false none none
»» timestamp string false none none
» total_count integer false none none

GET v1r1_enterprise_calls{call_id}_attachments

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/calls/{call_id}/attachments

Get attachments for session call

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID

Example responses

200 Response

[
  {
    "creator": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "deleted": true,
    "id": 0,
    "mime_type": "string",
    "name": "string",
    "path": "string",
    "progress": 0,
    "signed_url": "string",
    "status": "string",
    "thumbnail": "string",
    "timestamp": "string",
    "type": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns list of attachments Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [call_attachmentV1R1] false none none
» creator attachment_creator false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none User identifier
»» name string false none Display name of user
» deleted boolean false none none
» id integer(int32) false none Call attachment identifier
» mime_type string false none none
» name string false none none
» path string false none none
» progress integer false none none
» signed_url string false none none
» status string false none none
» thumbnail string false none none
» timestamp string false none none
» type string false none none

DELETE v1r1_enterprise_calls{call_id}attachments{attachment_id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}

Deletes a call attachment (marks it as deleted and clears out URLs)

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID
attachment_id path string true Attachment ID

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_calls{call_id}attachments{attachment_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/calls/{call_id}/attachments/{attachment_id}

Get an attachment for a call

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID
attachment_id path string true Attachment ID

Example responses

200 Response

[
  {
    "creator": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "deleted": true,
    "id": 0,
    "mime_type": "string",
    "name": "string",
    "path": "string",
    "progress": 0,
    "signed_url": "string",
    "status": "string",
    "thumbnail": "string",
    "timestamp": "string",
    "type": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns an attachment Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [call_attachmentV1R1] false none none
» creator attachment_creator false none none
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none User identifier
»» name string false none Display name of user
» deleted boolean false none none
» id integer(int32) false none Call attachment identifier
» mime_type string false none none
» name string false none none
» path string false none none
» progress integer false none none
» signed_url string false none none
» status string false none none
» thumbnail string false none none
» timestamp string false none none
» type string false none none

GET v1r1_enterprise_calls{call_id}_comments

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/calls/{call_id}/comments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/calls/{call_id}/comments

Get comments for session call

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
call_id path string true Call ID

Example responses

200 Response

[
  {
    "comment": "string",
    "creator": [
      {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "name": "string",
        "username": "string"
      }
    ],
    "enterprise_id": "string",
    "id": 0,
    "inserted_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns list of comments Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [call_comment] false none none
» comment string false none The comment text
» creator [comments_creator] false none The user that added the comment
»» avatar avatarV1 false none none
»»» full string false none URL to full-size avatar
»»» thumb string false none URL avatar thumbnail
»» id integer(int32) false none User identifier
»» name string false none Display name of user
»» username string false none Username of user
» enterprise_id string false none Enterprise ID that the comment exists in
» id integer(int32) false none Call comment identifier
» inserted_at string(date-time) false none none
» updated_at string(date-time) false none none

GET v1r1_enterprise_sessions{session_id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/sessions/{session_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/sessions/{session_id}

Gets information about a user

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
session_id path string true ID of session to retrieve information about

Example responses

200 Response

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "active": true,
      "enterprise_id": 0,
      "id": "string",
      "name": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns information about the session sessionV1R1
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_workboxes_by_call_id{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workboxes/by_call_id/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workboxes/by_call_id/{id}

Get a workbox by call id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path string true Call ID

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Help Threads

Help Threads at the Enterprise Level

GET v1_enterprise_workboxes{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/workboxes/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/workboxes/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/workboxes/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/workboxes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/workboxes/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/workboxes/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/workboxes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/workboxes/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/workboxes/{id}

Gets an enterprise workbox.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Workbox ID

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_at": "string",
  "created_by": "string",
  "custom_fields": [
    {
      "name": "string",
      "status": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "description": "string",
  "duration": 0,
  "id": 0,
  "status": "string",
  "ticket_id": 0,
  "ticket_type": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns an enterprise invitation as a map. enterprise_workboxV1
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
500 Internal Server Error Internal error errorV1

GET _v1r1_enterprise_workboxes

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workboxes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workboxes

Gets all enterprise workboxes

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.
after query string false Cursor for start of the results to return
status query string false Status, can be ALL, OPEN, REPORTED, ASSIGNED or CLOSED, defaults to ALL
filter query string false Filters resources based on key, value and an inequality

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "assigned_at": "string",
      "closed_at": "string",
      "created_by": {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "location": "string",
        "name": "string",
        "title": "string",
        "username": "string"
      },
      "description": "string",
      "fields": [
        {}
      ],
      "guests": [
        {
          "has_joined": true,
          "id": 0,
          "last_read_message_id": 0,
          "name": "string",
          "unread_count": 0,
          "uuid": "string"
        }
      ],
      "queues": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "assigned_to": {
        "id": 0,
        "name": "string"
      },
      "id": 0,
      "inserted_at": "string",
      "last_active_at": "string",
      "last_read_message_id": 0,
      "participants": [
        {
          "accepted_at": "string",
          "assigned": true,
          "creator": true,
          "has_participated": true,
          "id": 0,
          "important": true,
          "name": "string",
          "removed": true
        }
      ],
      "procedureCount": 0,
      "procedures": [
        {}
      ],
      "reported_at": "string",
      "status": "string",
      "ticketFieldsFull": [
        {}
      ],
      "token": "string",
      "unread_messages_count": 0,
      "updated_at": "string",
      "version": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK success, returns the workboxes Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning workbox results in subsequent calls
» entries [workbox] false none none
»» assigned_at string false none none
»» closed_at string false none none
»» created_by brief_contact false none none
»»» avatar avatarV1 false none none
»»»» full string false none URL to full-size avatar
»»»» thumb string false none URL avatar thumbnail
»»» id integer(int32) false none ID of the user
»»» location string false none none
»»» name string false none none
»»» title string false none none
»»» username string false none none
»» description string false none none
»» fields [object] false none workbox custom fields
»» guests [workbox_guest] false none none
»»» has_joined boolean false none none
»»» id integer(int32) false none none
»»» last_read_message_id integer(int32) false none none
»»» name string false none none
»»» unread_count integer(int32) false none none
»»» uuid string false none none
»» queues [object] false none none
»»» id integer(int32) false none none
»»» name string false none none
»» assigned_to object false none none
»»» id integer(int32) false none none
»»» name string false none none
»» id integer(int32) false none The unique workbox ID
»» inserted_at string false none none
»» last_active_at string false none none
»» last_read_message_id integer(int32) false none none
»» participants [workbox_participant] false none none
»»» accepted_at string false none none
»»» assigned boolean false none Whether or not the associated workbox is assigned to this participant
»»» creator boolean false none Whether or not this user is the initial creator of the workbox
»»» has_participated boolean false none none
»»» id integer(int32) false none ID of the participant in the session (NOT the user id)
»»» important boolean false none Whether or not the user marked the associated workbox as important
»»» name string false none none
»»» removed boolean false none Whether or not this user was removed from the workbox
»» procedureCount number false none workbox procedures which does not deleted
»» procedures [object] false none workbox procedures
»» reported_at string false none none
»» status string false none Status of the workbox, may be REPORTED, ASSIGNED or CLOSED
»» ticketFieldsFull [object] false none workspace custom fields
»» token string false none A JWT used to manipulate the workbox
»» unread_messages_count integer(int32) false none none
»» updated_at string false none none
»» version string false none The version of the workbox

POST _v1r1_enterprise_workboxes

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/workboxes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/workboxes HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "owner_id": 0,
  "participant_ids": [],
  "title": ""
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workboxes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/workboxes

Create a new workbox in the enterprise

Body parameter

{
  "owner_id": 0,
  "participant_ids": [],
  "title": ""
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» owner_id body integer(int32) false The owner of the workbox. They must exist in this enterprise
» participant_ids body [integer] false List of participants to include in the workbox
» title body string false Optional title for the workbox

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the created workbox workbox
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_workboxes{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workboxes/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workboxes/{id}

Get a workbox by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Workbox ID

Example responses

200 Response

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK success, returns the workbox workbox
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Reporting

Endpoints for generating reports

GET _v1_enterprise_calls_report

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/calls/report \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/calls/report HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls/report',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/calls/report',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/calls/report', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/calls/report', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/calls/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/calls/report

Get a report of the calls

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "csv": "string",
  "error": "string",
  "response": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise calls for a report hermes_enterprise_report
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_calls_stats

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/calls/stats \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/calls/stats HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/calls/stats',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/calls/stats',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/calls/stats', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/calls/stats', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/calls/stats");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/calls/stats", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/calls/stats

Gets the call stats for an enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "stats": {
    "activeUsersPastWeek": [
      {
        "doc_count": "string",
        "key": "string"
      }
    ],
    "callLengthsPastWeek": [
      0
    ],
    "callsLastWeek": 0,
    "callsPerDay": [
      {
        "x": 0,
        "y": 0
      }
    ],
    "callsThisMonth": 0,
    "callsToday": 0,
    "totalUsers": 0
  }
}

Responses

Status Meaning Description Schema
200 OK The call stats hermes_call_stats
401 Unauthorized Invalid token string
403 Forbidden Access Denied string
500 Internal Server Error Internal error errorV1

GET _v1_enterprise_users_report

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/users/report \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/users/report HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/users/report',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/users/report',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/users/report', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/users/report', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/users/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/users/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/users/report

Gets a report of the users

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "csv": "string",
  "error": "string",
  "response": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise user for a report hermes_enterprise_report
401 Unauthorized Invalid token string
500 Internal Server Error Internal error errorV1

POST _v1r1_enterprise_reports_active_users

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "all_workspace": true,
  "call_duration": 0,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/active_users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/active_users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/active_users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/active_users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/active_users

Generate a list of active users reports

Body parameter

{
  "all_workspace": true,
  "call_duration": 0,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» all_workspace body boolean false Get all workspace or not.
» call_duration body integer false The number of call duration in seconds.
» end_date body string false The end date.
» end_status body string false The end status of a user in a call.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "columns": [
    "string"
  ],
  "values": [
    {
      "data": [
        0
      ],
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report analytics_report
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_active_users_download

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "all_workspace": true,
  "call_duration": 0,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/active_users/download", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/active_users/download

Generate csv active users reports

Body parameter

{
  "all_workspace": true,
  "call_duration": 0,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» all_workspace body boolean false Get all workspace or not.
» call_duration body integer false The number of call duration in seconds.
» end_date body string false The end date.
» end_status body string false The end status of a user in a call.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report report_uuid
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_active_users_by_call

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "all_workspace": true,
  "category": "string",
  "end_date": "string",
  "groups": [
    0
  ],
  "most_active": true,
  "start_date": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/active_users_by_call

Generate a list of active users by call reports

Body parameter

{
  "all_workspace": true,
  "category": "string",
  "end_date": "string",
  "groups": [
    0
  ],
  "most_active": true,
  "start_date": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» all_workspace body boolean false Get all workspace or not.
» category body string false The category of getting call report.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» most_active body boolean false The most active or least active call.
» start_date body string false The start date.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "columns": [
    "string"
  ],
  "values": [
    {
      "data": [
        0
      ],
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report analytics_report
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_active_users_by_call_download

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "all_workspace": true,
  "category": "string",
  "end_date": "string",
  "groups": [
    0
  ],
  "most_active": true,
  "start_date": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/active_users_by_call/download", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/active_users_by_call/download

Generate csv active users by call reports

Body parameter

{
  "all_workspace": true,
  "category": "string",
  "end_date": "string",
  "groups": [
    0
  ],
  "most_active": true,
  "start_date": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» all_workspace body boolean false Get all workspace or not.
» category body string false The category of getting call report.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» most_active body boolean false The most active or least active call.
» start_date body string false The start date.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report report_uuid
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_call_durations

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/call_durations

Generate a list of call durations reports

Body parameter

{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» aggregate body boolean false Aggregate of this report.
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» tags body [integer] false List of tags.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "columns": [
    "string"
  ],
  "values": [
    {
      "data": [
        0
      ],
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report analytics_report
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_call_durations_download

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/call_durations/download", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/call_durations/download

Generate csv call durations reports

Body parameter

{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» aggregate body boolean false Aggregate of this report.
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» tags body [integer] false List of tags.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report report_uuid
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_reports_calls

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/reports/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/reports/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/calls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/reports/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/reports/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/reports/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/reports/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/reports/calls

Get a list of recently generated reports (both csv and json)

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "inserted_at": "2019-08-24T14:15:22Z",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "url": "string",
    "uuid": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of Report Statuses report_statuses
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_calls

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/calls',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/calls

Start the generation of all the calls in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, Report UUID report_uuid
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_calls.json

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/calls.json", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/calls.json

Get a report of all the calls in the enterprise in json format

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, Report UUID report_uuid
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_reports_calls{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/reports/calls/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/reports/calls/{id}

Get the status of a call report

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path string true report id

Example responses

200 Response

{
  "inserted_at": "2019-08-24T14:15:22Z",
  "status": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "url": "string",
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the status of a report report_status
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_calls_usage

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "usage": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/calls_usage

Generate a list of calls usage reports

Body parameter

{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "usage": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» aggregate body boolean false Aggregate of this report.
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» tags body [integer] false List of tags.
» usage body string false The usage of a call.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "columns": [
    "string"
  ],
  "values": [
    {
      "data": [
        0
      ],
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report analytics_report
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_calls_usage_download

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "usage": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/calls_usage/download", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/calls_usage/download

Generate csv calls usage reports

Body parameter

{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "usage": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» aggregate body boolean false Aggregate of this report.
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» tags body [integer] false List of tags.
» usage body string false The usage of a call.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report report_uuid
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_total_calls

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/total_calls

Generate a list of total calls reports

Body parameter

{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» aggregate body boolean false Aggregate of this report.
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» end_status body string false The end status of a user in a call.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» tags body [integer] false List of tags.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "columns": [
    "string"
  ],
  "values": [
    {
      "data": [
        0
      ],
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report analytics_report
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_total_calls_download

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/total_calls/download", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/total_calls/download

Generate csv total calls reports

Body parameter

{
  "aggregate": true,
  "all_workspace": true,
  "end_date": "string",
  "end_status": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "tags": [
    0
  ],
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» aggregate body boolean false Aggregate of this report.
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» end_status body string false The end status of a user in a call.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» tags body [integer] false List of tags.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report report_uuid
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_total_users

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_users HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/total_users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/total_users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/total_users', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/total_users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/total_users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/total_users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/total_users

Generate a list of total users reports

Body parameter

{
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "columns": [
    "string"
  ],
  "values": [
    {
      "data": [
        0
      ],
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report analytics_report
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_total_users_download

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/total_users/download", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/total_users/download

Generate csv total users reports

Body parameter

{
  "all_workspace": true,
  "end_date": "string",
  "groups": [
    0
  ],
  "start_date": "string",
  "workspace_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» all_workspace body boolean false Get all workspace or not.
» end_date body string false The end date.
» groups body [integer] false List of groups.
» start_date body string false The start date.
» workspace_id body integer false Id of workspace.

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the data of a report report_uuid
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_reports_workboxes

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/reports/workboxes

Get a list of reports (both csv and json)

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

[
  {
    "inserted_at": "2019-08-24T14:15:22Z",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "url": "string",
    "uuid": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise users report_statuses
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_workboxes

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/workboxes

Generate a CSV report of all of the workboxes

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success report_uuid
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_reports_workboxes.json

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes.json", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/reports/workboxes.json

Generate a JSON report of all of the workboxes

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token

Example responses

200 Response

{
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success report_uuid
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_reports_workboxes{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/reports/workboxes/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/reports/workboxes/{id}

Get the status of a workbox report

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path string true report id

Example responses

200 Response

{
  "inserted_at": "2019-08-24T14:15:22Z",
  "status": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "url": "string",
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the status of a report report_status
400 Bad Request A generic error response errorV1R1

GET _v1r1_enterprise_workboxes_report

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workboxes/report \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workboxes/report HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workboxes/report',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workboxes/report',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workboxes/report', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workboxes/report', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workboxes/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workboxes/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workboxes/report

Gets all enterprise workboxes report

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "close_at": "string",
      "create_at": "string",
      "custom_fields": [
        {
          "name": "string",
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "description": "string",
      "duration": 0,
      "owner": "string",
      "owner_email": "string",
      "owner_groups": [
        {}
      ],
      "owner_location": "string",
      "owner_title": "string",
      "participants": [
        {}
      ],
      "status": "string",
      "ticket_id": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of enterprise workboxes report enterprise_workboxes_reports
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Workspace Management

Endpoints for Workspace Management

GET _v1r1_enterprise_workspaces

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workspaces \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workspaces HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workspaces',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workspaces',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workspaces', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workspaces', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workspaces");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workspaces", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workspaces

Get a list of all workspaces in this enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false Orders returned resource list using ordered list of keys.
filter query string false Filters resources based on key, value and an inequality
page query integer(int32) false none
page_size query integer(int32) false none

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "admins": [
        {
          "email": "string",
          "id": 0,
          "name": "string",
          "parent_id": 0
        }
      ],
      "id": 0,
      "name": "string",
      "token": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of workspaces enterprise_workspaces
400 Bad Request A generic error response errorV1R1

POST _v1r1_enterprise_workspaces

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1r1/enterprise/workspaces \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1r1/enterprise/workspaces HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workspaces',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1r1/enterprise/workspaces',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1r1/enterprise/workspaces', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1r1/enterprise/workspaces', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workspaces");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1r1/enterprise/workspaces", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1r1/enterprise/workspaces

Create a new workspace

Body parameter

{
  "name": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» name body string true The name of workspace

Example responses

200 Response

{
  "active": true,
  "admins": [
    {
      "email": "string",
      "id": 0,
      "name": "string",
      "parent_id": 0
    }
  ],
  "id": 0,
  "name": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, the new workspace enterprise_workspace
400 Bad Request A generic error response errorV1R1

DELETE v1r1_enterprise_workspaces{id}

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1r1/enterprise/workspaces/{id}

Delete a workspace

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true workspace id

Example responses

200 Response

{
  "message": "string",
  "status": true
}

Responses

Status Meaning Description Schema
200 OK The operation was successful. success
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_workspaces{id}

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workspaces/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workspaces/{id}

Get a workspace by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true workspace id

Example responses

200 Response

{
  "active": true,
  "admins": [
    {
      "email": "string",
      "id": 0,
      "name": "string",
      "parent_id": 0
    }
  ],
  "id": 0,
  "name": "string",
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, the new workspace enterprise_workspace
400 Bad Request A generic error response errorV1R1

GET v1r1_enterprise_workspaces{workspace_id}_users_options

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1r1/enterprise/workspaces/{workspace_id}/users/options", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1r1/enterprise/workspaces/{workspace_id}/users/options

Gets a list of users who can be added or removed from the workspace

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
workspace_id path integer true Workspace ID
search_term query string false Text search term
page query integer(int32) false none
page_size query integer(int32) false none
include_all query boolean false Whether or not to include all users in the enterprise, or just the users in this workspace

Example responses

200 Response

{
  "entries": [
    {
      "active": true,
      "alias_user_id": 0,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "email": "string",
      "id": 0,
      "included_in_workspace": true,
      "location": "string",
      "name": "string",
      "title": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Responses

Status Meaning Description Schema
200 OK Success, list of users for that can be added or removed from the workspace workspace_user_options
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Area and Asset Management

Endpoints for Area and Asset Management

paginate_areas_by_enterprise

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/areas \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/areas HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/areas',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/areas', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/areas', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/areas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/areas

Paginate through all Area objects in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
limit query integer false Max areas to return
after query string false Cursor for the page to return
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "id": 0,
      "name": "string",
      "enterprise_id": 0,
      "uuid": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "updated_at": "2019-08-24T14:15:22Z",
      "inserted_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "deleted": true
    }
  ],
  "after": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of areas areas_page
400 Bad Request A generic error response errorV1R1

create_area_in_enterprise

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/areas \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/areas HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "name": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "uuid": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/areas',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/areas', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/areas', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/areas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/areas

Create a new area in the enterprise

Body parameter

{
  "name": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "uuid": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object false none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "enterprise_id": 0,
  "uuid": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the created area area
400 Bad Request A generic error response errorV1R1

paginate_areas_near_position

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/areas/near \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/areas/near HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/near',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/areas/near',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/areas/near', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/areas/near', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/near");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/areas/near", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/areas/near

Paginate through all Area objects in the enterprise near a position

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
latitude query number(float) false Latitude of the position to search for nearby areas
longitude query number(float) false Longitude of the position to search for nearby areas
distance query number(float) false Distance from the position to search for nearby areas, in kilometers
limit query integer false Max areas to return
after query string false Cursor for the page to return
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "id": 0,
      "name": "string",
      "enterprise_id": 0,
      "uuid": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "updated_at": "2019-08-24T14:15:22Z",
      "inserted_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "deleted": true
    }
  ],
  "after": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of areas areas_page
400 Bad Request A generic error response errorV1R1

get_enterprise_area_by_id

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/areas/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/areas/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/areas/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/areas/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/areas/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/areas/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/areas/{id}

Gets an area in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Area ID

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "enterprise_id": 0,
  "uuid": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns an area area
400 Bad Request A generic error response errorV1R1

update_enterprise_area_by_id

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/areas/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/areas/{id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "name": "string",
  "latitude": 0.1,
  "longitude": 0.1
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/areas/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/areas/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/areas/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/areas/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/areas/{id}

Updates an area in the enterprise

Body parameter

{
  "name": "string",
  "latitude": 0.1,
  "longitude": 0.1
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Area ID
body body object false none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "enterprise_id": 0,
  "uuid": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the udpated area area
400 Bad Request A generic error response errorV1R1

update_enterprise_delete_by_id

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/areas/{id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/areas/{id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/areas/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/areas/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/areas/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/areas/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/areas/{id}

Deletes an area in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
id path integer true Area ID

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "enterprise_id": 0,
  "uuid": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the deleted area area
400 Bad Request A generic error response errorV1R1

create_asset_in_area

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "name": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "uuid": "string",
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/areas/{area_id}/assets

Create a new asset in the area

Body parameter

{
  "name": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "uuid": "string",
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
area_id path integer true Area ID
body body object false none

Example responses

200 Response

{
  "id": 0,
  "enterprise_id": 0,
  "area_id": 0,
  "uuid": "string",
  "name": "string",
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true,
  "latitude": 0.1,
  "longitude": 0.1,
  "last_update": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the created asset asset
400 Bad Request A generic error response errorV1R1

paginate_assets_by_area

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/areas/{area_id}/assets

Paginate through all Asset objects in the area

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
area_id path integer true Area ID
limit query integer false Max assets to return
after query string false Cursor for the page to return
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "id": 0,
      "enterprise_id": 0,
      "area_id": 0,
      "uuid": "string",
      "name": "string",
      "description": "string",
      "serial_number": "string",
      "model_number": "string",
      "error_message": "string",
      "error": true,
      "latitude": 0.1,
      "longitude": 0.1,
      "last_update": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "inserted_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "deleted": true
    }
  ],
  "after": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of assets assets_page
400 Bad Request A generic error response errorV1R1

paginate_assets_by_area_near_position

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/near", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/areas/{area_id}/assets/near

Paginate through all Asset objects in the Area near a position

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
area_id path integer true Area ID
latitude query number(float) false Latitude of the position to search for nearby assets
longitude query number(float) false Longitude of the position to search for nearby assets
distance query number(float) false Distance from the position to search for nearby assets, in kilometers
limit query integer false Max assets to return
after query string false Cursor for the page to return
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "id": 0,
      "enterprise_id": 0,
      "area_id": 0,
      "uuid": "string",
      "name": "string",
      "description": "string",
      "serial_number": "string",
      "model_number": "string",
      "error_message": "string",
      "error": true,
      "latitude": 0.1,
      "longitude": 0.1,
      "last_update": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "inserted_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "deleted": true
    }
  ],
  "after": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of assets assets_page
400 Bad Request A generic error response errorV1R1

get_asset_in_area

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/areas/{area_id}/assets/{asset_id}

Gets an asset in the area

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
area_id path integer true Area ID
asset_id path integer true Asset ID

Example responses

200 Response

{
  "id": 0,
  "enterprise_id": 0,
  "area_id": 0,
  "uuid": "string",
  "name": "string",
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true,
  "latitude": 0.1,
  "longitude": 0.1,
  "last_update": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the asset asset
400 Bad Request A generic error response errorV1R1

update_asset_in_area

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "name": "string",
  "new_area_id": 0,
  "latitude": 0.1,
  "longitude": 0.1,
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/areas/{area_id}/assets/{asset_id}

Updates an asset in the area

Body parameter

{
  "name": "string",
  "new_area_id": 0,
  "latitude": 0.1,
  "longitude": 0.1,
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
area_id path integer true Area ID
asset_id path integer true Asset ID
body body object false none

Example responses

200 Response

{
  "id": 0,
  "enterprise_id": 0,
  "area_id": 0,
  "uuid": "string",
  "name": "string",
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true,
  "latitude": 0.1,
  "longitude": 0.1,
  "last_update": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the updated asset asset
400 Bad Request A generic error response errorV1R1

delete_asset_in_area

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/areas/{area_id}/assets/{asset_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/areas/{area_id}/assets/{asset_id}

Deletes an asset in the area

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
area_id path integer true Area ID
asset_id path integer true Asset ID

Example responses

200 Response

{
  "id": 0,
  "enterprise_id": 0,
  "area_id": 0,
  "uuid": "string",
  "name": "string",
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true,
  "latitude": 0.1,
  "longitude": 0.1,
  "last_update": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the deleted asset asset
400 Bad Request A generic error response errorV1R1

paginate_assets_by_enterprise

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/assets \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/assets HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/assets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/assets',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/assets', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/assets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/assets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/assets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/assets

Paginate through all Asset objects in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
limit query integer false Max assets to return
after query string false Cursor for the page to return
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "id": 0,
      "enterprise_id": 0,
      "area_id": 0,
      "uuid": "string",
      "name": "string",
      "description": "string",
      "serial_number": "string",
      "model_number": "string",
      "error_message": "string",
      "error": true,
      "latitude": 0.1,
      "longitude": 0.1,
      "last_update": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "inserted_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "deleted": true
    }
  ],
  "after": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of assets assets_page
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Automations

Endpoints for Automations Management

GET _v1_enterprise_automations

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/automations \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/automations HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/automations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/automations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/automations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/automations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/automations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/automations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/automations

Get enterprise automations.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
order query string false none
filter query string false none
limit query integer false Maximum number of results to return. Defaults -1, return server configured amount.
after query string false Cursor for start of the results to return

Example responses

200 Response

{
  "after": "string",
  "entries": [
    {
      "id": 0,
      "name": "string",
      "injector_id": "string",
      "flow": "string",
      "public": true,
      "verb": "string",
      "inserted_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success, returns the enterprise automations. Inline
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
404 Not Found Resource Not Found errorV1
500 Internal Server Error Internal error errorV1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» after string false none Cursor to continue returning workbox results in subsequent calls
» entries [enterprise_automation] false none none
»» id integer false none Automation id
»» name string false none Automation name
»» injector_id string false none Injector id
»» flow string false none Flow content
»» public boolean false none Public automation or not
»» verb string false none Automation verb
»» inserted_at string(date-time) false none Automation inserted at
»» updated_at string(date-time) false none Automation updated at

GET _v1_enterprise_automation

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/automation/{automation_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/automation/{automation_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/automation/{automation_id}

Get enterprise automation.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
automation_id path integer true Automation id

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "injector_id": "string",
  "flow": "string",
  "public": true,
  "verb": "string",
  "inserted_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Success, returns an enterprise automation. enterprise_automation
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
404 Not Found Resource Not Found errorV1
500 Internal Server Error Internal error errorV1

DELETE _v1_enterprise_automation

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/automation/{automation_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/automation/{automation_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/automation/{automation_id}

Delete enterprise automation.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
automation_id path integer true Automation id

Example responses

401 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success None
401 Unauthorized Could not find resource or you do not have access to the resource. errorV1
404 Not Found Resource Not Found errorV1
500 Internal Server Error Internal error errorV1

PUT _v1_enterprise_automation

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/automation/{automation_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/automation/{automation_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "injector_id": "string",
  "flow": "string",
  "name": "string",
  "public": true,
  "verb": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/automation/{automation_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/automation/{automation_id}

Update enterprise automation

Body parameter

{
  "injector_id": "string",
  "flow": "string",
  "name": "string",
  "public": true,
  "verb": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
automation_id path integer true Automation id
body body object true none
» injector_id body string false automation injector id
» flow body string false automation flow content
» name body string false automation name
» public body boolean false automation public or not
» verb body string false automation verb

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "injector_id": "string",
  "flow": "string",
  "public": true,
  "verb": "string",
  "inserted_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Success, returns automation just updated enterprise_automation
401 Unauthorized Unauthorized, login credentials invalid errorV1

POST _v1_enterprise_automation

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/automation \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/automation HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "flow": "string",
  "injector_id": "string",
  "name": "string",
  "public": true,
  "verb": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/automation',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/automation',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/automation', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/automation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/automation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/automation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/automation

Create enterprise automation

Body parameter

{
  "flow": "string",
  "injector_id": "string",
  "name": "string",
  "public": true,
  "verb": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object true none
» flow body string true automation flow content
» injector_id body string false automation injector id
» name body string false automation name
» public body boolean false automation public or not
» verb body string false automation verb

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "injector_id": "string",
  "flow": "string",
  "public": true,
  "verb": "string",
  "inserted_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Success, returns automation just created enterprise_automation
401 Unauthorized Unauthorized, login credentials invalid errorV1

Enterprise-Level: Queues

paginate_enterprise_queues

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/queues \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/queues HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/queues',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/queues', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/queues', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/queues", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/queues

Paginate through all the workbox queues in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor to retrieve results from, optional
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "id": "string",
      "enterprise_id": "string",
      "name": "string",
      "description": "string",
      "updated_at": "string",
      "inserted_at": "string",
      "notify_users_via_realtime": true,
      "notify_users_via_email": true,
      "notify_admins_via_email": true,
      "notify_admins_via_realtime": true
    }
  ],
  "after": "string",
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of queues enterprise_queue_page
400 Bad Request A generic error response errorV1R1

create_queue_in_enterprise

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/queues \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/queues HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "name": "string",
  "description": "string",
  "pod_ids": [
    0
  ],
  "notify_users_via_realtime": "none",
  "notify_users_via_email": "none",
  "notify_admins_via_realtime": "none",
  "notify_admins_via_email": "none"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/queues',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/queues', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/queues', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/queues", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/queues

Create a new workbox queue in the enterprise

Body parameter

{
  "name": "string",
  "description": "string",
  "pod_ids": [
    0
  ],
  "notify_users_via_realtime": "none",
  "notify_users_via_email": "none",
  "notify_admins_via_realtime": "none",
  "notify_admins_via_email": "none"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
body body object false none

Example responses

200 Response

{
  "id": "string",
  "enterprise_id": "string",
  "name": "string",
  "description": "string",
  "unassigned_workboxes_count": 0,
  "open_workboxes_count": 0,
  "updated_at": "string",
  "inserted_at": "string",
  "pod_ids": [
    "string"
  ],
  "notify_users_via_realtime": true,
  "notify_users_via_email": true,
  "notify_admins_via_email": true,
  "notify_admins_via_realtime": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the created queue enterprise_queue
400 Bad Request A generic error response errorV1R1

paginate_enterprise_queues_workboxes

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/queues/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/queues/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/workboxes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/queues/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/queues/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/queues/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/queues/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/queues/workboxes

Paginate through all workboxes in every queue in the enterprise.

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor to retrieve results from, optional
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "priority": "string",
      "assigned": true,
      "assigned_to": "string",
      "updated_at": "string",
      "inserted_at": "string",
      "workbox": {
        "assigned_at": "string",
        "closed_at": "string",
        "created_by": {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "location": "string",
          "name": "string",
          "title": "string",
          "username": "string"
        },
        "description": "string",
        "fields": [
          {}
        ],
        "guests": [
          {
            "has_joined": true,
            "id": 0,
            "last_read_message_id": 0,
            "name": "string",
            "unread_count": 0,
            "uuid": "string"
          }
        ],
        "queues": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "assigned_to": {
          "id": 0,
          "name": "string"
        },
        "id": 0,
        "inserted_at": "string",
        "last_active_at": "string",
        "last_read_message_id": 0,
        "participants": [
          {
            "accepted_at": "string",
            "assigned": true,
            "creator": true,
            "has_participated": true,
            "id": 0,
            "important": true,
            "name": "string",
            "removed": true
          }
        ],
        "procedureCount": 0,
        "procedures": [
          {}
        ],
        "reported_at": "string",
        "status": "string",
        "ticketFieldsFull": [
          {}
        ],
        "token": "string",
        "unread_messages_count": 0,
        "updated_at": "string",
        "version": "string"
      },
      "queue_id": 0
    }
  ],
  "after": "string",
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of users queued_workbox_page
400 Bad Request A generic error response errorV1R1

get_enterprise_queues_by_queue

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/queues/{queue_id}

Get a user queue by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID

Example responses

200 Response

{
  "id": "string",
  "enterprise_id": "string",
  "name": "string",
  "description": "string",
  "unassigned_workboxes_count": 0,
  "open_workboxes_count": 0,
  "updated_at": "string",
  "inserted_at": "string",
  "pod_ids": [
    "string"
  ],
  "notify_users_via_realtime": true,
  "notify_users_via_email": true,
  "notify_admins_via_email": true,
  "notify_admins_via_realtime": true
}

Responses

Status Meaning Description Schema
200 OK success, returns the queue enterprise_queue
400 Bad Request A generic error response errorV1R1

update_enterprise_queue_by_id

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/queues/{queue_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/queues/{queue_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "name": "string",
  "description": "string",
  "pod_ids": [
    0
  ],
  "notify_users_via_realtime": "string",
  "notify_users_via_email": "string",
  "notify_admins_via_realtime": "string",
  "notify_admins_via_email": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/queues/{queue_id}

Updates a workbox queue in the enterprise

Body parameter

{
  "name": "string",
  "description": "string",
  "pod_ids": [
    0
  ],
  "notify_users_via_realtime": "string",
  "notify_users_via_email": "string",
  "notify_admins_via_realtime": "string",
  "notify_admins_via_email": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
body body object false none

Example responses

200 Response

{
  "id": "string",
  "enterprise_id": "string",
  "name": "string",
  "description": "string",
  "unassigned_workboxes_count": 0,
  "open_workboxes_count": 0,
  "updated_at": "string",
  "inserted_at": "string",
  "pod_ids": [
    "string"
  ],
  "notify_users_via_realtime": true,
  "notify_users_via_email": true,
  "notify_admins_via_email": true,
  "notify_admins_via_realtime": true
}

Responses

Status Meaning Description Schema
200 OK Success, returns the updated queue enterprise_queue
400 Bad Request A generic error response errorV1R1

delete_enterprise_queue_by_id

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/queues/{queue_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/queues/{queue_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/queues/{queue_id}

Deletes a workbox queue in the enterprise

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, returns true None
400 Bad Request A generic error response errorV1R1

paginate_enterprise_queues_experts_by_queue

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/experts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/queues/{queue_id}/experts

Paginate through experts in a queue

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor to retrieve results from, optional
search query string false The search term for name or email of expert

Example responses

200 Response

{
  "entries": [
    {
      "id": 0,
      "name": "string",
      "email": "string",
      "title": "string",
      "location": "string",
      "avatar": {
        "full": "string",
        "thumb": "string"
      }
    }
  ],
  "after": "string",
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of queued workboxes experts_page
400 Bad Request A generic error response errorV1R1

paginate_enterprise_queues_workboxes_by_queue

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/queues/{queue_id}/workboxes

Paginate through workboxes in a queue

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
limit query integer false Max results returned. Defaults -1, return server configured amount.
after query string false Cursor to retrieve results from, optional
filter query string false Filters resources based on key, value and an inequality
order query string false Orders returned resource list using ordered list of keys.

Example responses

200 Response

{
  "entries": [
    {
      "priority": "string",
      "assigned": true,
      "assigned_to": "string",
      "updated_at": "string",
      "inserted_at": "string",
      "workbox": {
        "assigned_at": "string",
        "closed_at": "string",
        "created_by": {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "location": "string",
          "name": "string",
          "title": "string",
          "username": "string"
        },
        "description": "string",
        "fields": [
          {}
        ],
        "guests": [
          {
            "has_joined": true,
            "id": 0,
            "last_read_message_id": 0,
            "name": "string",
            "unread_count": 0,
            "uuid": "string"
          }
        ],
        "queues": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "assigned_to": {
          "id": 0,
          "name": "string"
        },
        "id": 0,
        "inserted_at": "string",
        "last_active_at": "string",
        "last_read_message_id": 0,
        "participants": [
          {
            "accepted_at": "string",
            "assigned": true,
            "creator": true,
            "has_participated": true,
            "id": 0,
            "important": true,
            "name": "string",
            "removed": true
          }
        ],
        "procedureCount": 0,
        "procedures": [
          {}
        ],
        "reported_at": "string",
        "status": "string",
        "ticketFieldsFull": [
          {}
        ],
        "token": "string",
        "unread_messages_count": 0,
        "updated_at": "string",
        "version": "string"
      },
      "queue_id": 0
    }
  ],
  "after": "string",
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns a page of queued workboxes queued_workbox_page
400 Bad Request A generic error response errorV1R1

get_enterprise_queues_workbox_by_workbox_id

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}

Get a workbox in a queue by id

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

update_enterprise_queues_workbox_by_workbox_id

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "priority": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}

Updates the properties of a queued workbox

Body parameter

{
  "priority": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID
body body object false none

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the updated queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

delete_enterprise_queue_workbox_by_workbox_id

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}

Removes a workbox from a queue

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, returns true None
400 Bad Request A generic error response errorV1R1

enterprise_assign_workbox_to_user

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "user_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/assign

Assign a workbox to a user

Body parameter

{
  "user_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID
body body object false none

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

enterprise_unassign_workbox

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/queues/{queue_id}/workboxes/{workbox_id}/unassign

Unassign a workbox from a user, putting it back in the queue

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
workbox_id path integer true Workbox ID

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

enqueue_workbox_in_queue

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "priority": 0,
  "workbox_id": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/enqueue", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/queues/{queue_id}/enqueue

Put a workbox into a queue

Body parameter

{
  "priority": 0,
  "workbox_id": 0
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
body body object false none

Example responses

200 Response

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Responses

Status Meaning Description Schema
200 OK Success, returns the queued workbox queued_workbox
400 Bad Request A generic error response errorV1R1

Enterprise-Level: Queue Notifications

create_queue_email

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "email": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/queues/{queue_id}/emails

Create a new email notification for the queue

Body parameter

{
  "email": "string"
}

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
body body object false none

Example responses

200 Response

{
  "id": 0,
  "email": "string",
  "validated": true,
  "updated_at": "string",
  "inserted_at": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns the created email notification details queue_email
400 Bad Request A generic error response errorV1R1

get_all_queue_emails

Code samples

# You can also use wget
curl -X GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


GET https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/enterprise/queues/{queue_id}/emails

Gets all of the email notifications for the queue

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID

Example responses

200 Response

[
  {
    "id": 0,
    "email": "string",
    "validated": true,
    "updated_at": "string",
    "inserted_at": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success, returns a list of email notifications Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [queue_email] false none none
» id integer false none The ID of the email notification
» email string false none The email address to use
» validated boolean false none Whether or not the email has been validated
» updated_at string false none A date string when this was last updated
» inserted_at string false none A date string when this was created

validate_queue_email

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate HTTP/1.1
Host: api.helplightning.net
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/validate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/enterprise/queues/{queue_id}/emails/validate

Validates an email notification for the queue

Parameters

Name In Type Required Description
queue_id path integer true Queue ID

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK Returns true if the email was validated boolean
400 Bad Request A generic error response errorV1R1

delete_queue_email_by_id

Code samples

# You can also use wget
curl -X DELETE https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id} \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


DELETE https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id} HTTP/1.1
Host: api.helplightning.net
Accept: application/json
authorization: string



const headers = {
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.helplightning.net/api/v1/enterprise/queues/{queue_id}/emails/{email_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/enterprise/queues/{queue_id}/emails/{email_id}

Deletes an email notifications in the queue

Parameters

Name In Type Required Description
authorization header string true An enterprise authorization token
queue_id path integer true Queue ID
email_id path integer true Email notification ID

Example responses

400 Response

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Responses

Status Meaning Description Schema
200 OK Success, returns true if deleted None
400 Bad Request A generic error response errorV1R1

User-Level: Surveys

create_survey

Code samples

# You can also use wget
curl -X POST https://api.helplightning.net/api/v1/surveys \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


POST https://api.helplightning.net/api/v1/surveys HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "platform": "web",
  "version": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/surveys',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.helplightning.net/api/v1/surveys',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.helplightning.net/api/v1/surveys', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.helplightning.net/api/v1/surveys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/surveys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.helplightning.net/api/v1/surveys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/surveys

Create a new end of call survey, leaving it blank

Body parameter

{
  "platform": "web",
  "version": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
body body object false none

Example responses

200 Response

{
  "survey_id": 0,
  "status": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a JSON map with the survey_id Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» survey_id integer false none The ID of the survey that was created
» status string false none Result of the operation, always 'success'
» message string false none Description of the operation

update_survey

Code samples

# You can also use wget
curl -X PUT https://api.helplightning.net/api/v1/surveys/{survey_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'authorization: string' \
  -H 'Authorization: API_KEY'


PUT https://api.helplightning.net/api/v1/surveys/{survey_id} HTTP/1.1
Host: api.helplightning.net
Content-Type: application/json
Accept: application/json
authorization: string


const inputBody = '{
  "stars": 0,
  "issues": [
    "could_not_see"
  ],
  "comments": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'authorization':'string',
  'Authorization':'API_KEY'
};

fetch('https://api.helplightning.net/api/v1/surveys/{survey_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'authorization' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.helplightning.net/api/v1/surveys/{survey_id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'authorization': 'string',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.helplightning.net/api/v1/surveys/{survey_id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'authorization' => 'string',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.helplightning.net/api/v1/surveys/{survey_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.helplightning.net/api/v1/surveys/{survey_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "authorization": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.helplightning.net/api/v1/surveys/{survey_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/surveys/{survey_id}

Update a survey that has already been created by the user

Body parameter

{
  "stars": 0,
  "issues": [
    "could_not_see"
  ],
  "comments": "string"
}

Parameters

Name In Type Required Description
authorization header string true A user authorization token
survey_id path integer true Survey ID to update
body body object false none

Example responses

200 Response

{
  "survey_id": 0,
  "status": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Success, returns a JSON map with the survey_id Inline
400 Bad Request A generic error response errorV1R1

Response Schema

Status Code 200

Name Type Required Restrictions Description
» survey_id integer false none The ID of the survey that was created
» status string false none Result of the operation, always 'success'
» message string false none Description of the operation

Schemas

badges

{
  "workboxes_unread_count": 0,
  "unassigned_count": 0,
  "sessions_unread_count": 0,
  "app_badge_count": 0
}

Properties

Name Type Required Restrictions Description
workboxes_unread_count integer(int32) false none Total unread messages across all workboxes
unassigned_count integer(int32) false none Total unassigned workboxes in queues
sessions_unread_count integer(int32) false none Total unread messages across all sessions
app_badge_count integer(int32) false none Total unread workbox and session messages

AuditLog

{
  "action_noun": "string",
  "action_verb": "string",
  "app_id": "string",
  "enterprise": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "2019-08-24T14:15:22Z",
  "ip_address": "string",
  "objects": [
    {
      "id": "string",
      "type": "string"
    }
  ],
  "subject": {
    "id": "string",
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
action_noun string false none action taken on
action_verb string false none action taken
app_id string false none Application Id of the subject
enterprise object false none none
» id integer false none enterprise id
» name string false none enterprise name
id integer false none Audit Log id
inserted_at string(date-time) false none Date of creation
ip_address string false none Ip address of the subject
objects [object] false none none
» id string false none id of the object
» type string false none Object type
subject object false none none
» id string false none subject id (may be user, enterprise, or system)
» name string false none subject name

AuditLogList

[
  {
    "action_noun": "string",
    "action_verb": "string",
    "app_id": "string",
    "enterprise": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "2019-08-24T14:15:22Z",
    "ip_address": "string",
    "objects": [
      {
        "id": "string",
        "type": "string"
      }
    ],
    "subject": {
      "id": "string",
      "name": "string"
    }
  }
]

Properties

Name Type Required Restrictions Description
anonymous [AuditLog] false none none

analytics_report

{
  "columns": [
    "string"
  ],
  "values": [
    {
      "data": [
        0
      ],
      "name": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
columns [string] false none The column names
values [object] false none The data sets
» data [number] false none The ordered y-values that correspond to the columns
» name string false none The legend

attachment_creator

{
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
avatar avatarV1 false none User's avatar URL
id integer(int32) false none User identifier
name string false none Display name of user

avatar2

{
  "original": "string",
  "thumb": "string"
}

Properties

Name Type Required Restrictions Description
original string false none URL to full-size avatar
thumb string false none URL avatar thumbnail

avatarV1

{
  "full": "string",
  "thumb": "string"
}

Properties

Name Type Required Restrictions Description
full string false none URL to full-size avatar
thumb string false none URL avatar thumbnail

brief_contact

{
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "id": 0,
  "location": "string",
  "name": "string",
  "title": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
avatar avatarV1 false none none
id integer(int32) false none ID of the user
location string false none none
name string false none none
title string false none none
username string false none none

brief_pod

{
  "admin_count": 0,
  "admins": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    }
  ],
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "subpods": [
    {
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ],
  "user_count": 0
}

Properties

Name Type Required Restrictions Description
admin_count integer(int32) false none Number of admins in the pod
admins [pod_admin] false none none
avatar avatarV1 false none Pod's Avatar URL for dashboard.
default boolean false none Denotes default pod
description string false none Description of the pod
enterprise_id integer(int32) false none Enterprise Identifier of the pod
id integer(int32) false none Identifier of the pod
name string false none Name of the pod
subpods [pod_subpod] false none none
user_count integer(int32) false none Number of users in the pod

brief_pods

{
  "entries": [
    {
      "admin_count": 0,
      "admins": [
        {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "name": "string"
        }
      ],
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "default": true,
      "description": "string",
      "enterprise_id": 0,
      "id": 0,
      "name": "string",
      "subpods": [
        {
          "id": 0,
          "manage": true,
          "name": "string"
        }
      ],
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [brief_pod] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

brief_userV1

{
  "avatar": {
    "original": "string",
    "thumb": "string"
  },
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
avatar avatar2 false none User's avatar URL
id integer(int32) false none User identifier
name string false none Display name of user

call_attachmentV1

{
  "creator": {
    "avatar": {
      "original": "string",
      "thumb": "string"
    },
    "id": 0,
    "name": "string"
  },
  "deleted": true,
  "id": 0,
  "mime_type": "string",
  "name": "string",
  "path": "string",
  "progress": 0,
  "signed_url": "string",
  "status": "unknown",
  "thumbnail": "string",
  "timestamp": 0,
  "type": "string"
}

Properties

Name Type Required Restrictions Description
creator brief_userV1 false none Map of some basic info about the creator of the attachment
deleted boolean false none Whether or not the attachment has been deleted
id integer(int32) false none Call attachment identifier
mime_type string false none Mime-type of the file, such as application/png
name string false none Name of attached file
path string false none the attachment path
progress integer false none The progress of the attachment during upload
signed_url string false none Signed URL to an S3 object that represents the original attachment
status string false none The recording status
thumbnail string false none If the attachment is an image, then a signed URL to the thumbnail
timestamp integer false none Linux timestamp of when the attachment was created during a call
type string false none incall, postcall or recording, determines whether or not this attachment was part of a call

Enumerated Values

Property Value
status unknown
status waiting
status ready
status starting
status processing
status finished
status error

call_attachmentV1R1

{
  "creator": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "name": "string"
  },
  "deleted": true,
  "id": 0,
  "mime_type": "string",
  "name": "string",
  "path": "string",
  "progress": 0,
  "signed_url": "string",
  "status": "string",
  "thumbnail": "string",
  "timestamp": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
creator attachment_creator false none The creator of the call attachment
deleted boolean false none none
id integer(int32) false none Call attachment identifier
mime_type string false none none
name string false none none
path string false none none
progress integer false none none
signed_url string false none none
status string false none none
thumbnail string false none none
timestamp string false none none
type string false none none

call_avatar

{
  "timestamp": "2019-08-24T14:15:22Z",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
timestamp string(date-time) false none none
url string false none none

call_comment

{
  "comment": "string",
  "creator": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string",
      "username": "string"
    }
  ],
  "enterprise_id": "string",
  "id": 0,
  "inserted_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
comment string false none The comment text
creator [comments_creator] false none The user that added the comment
enterprise_id string false none Enterprise ID that the comment exists in
id integer(int32) false none Call comment identifier
inserted_at string(date-time) false none none
updated_at string(date-time) false none none

call_contact

{
  "active": true,
  "anonymous": true,
  "available": true,
  "avatar": {
    "timestamp": "2019-08-24T14:15:22Z",
    "url": "string"
  },
  "email": "string",
  "enterprise_ids": [
    0
  ],
  "favorite": true,
  "id": "string",
  "is_group": true,
  "name": "string",
  "status": "string",
  "tags": [
    "string"
  ],
  "token": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none none
anonymous boolean false none none
available boolean false none none
avatar call_avatar false none none
email string false none none
enterprise_ids [integer] false none none
favorite boolean false none none
id string false none none
is_group boolean false none none
name string false none none
status string false none none
tags [string] false none none
token string false none none
username string false none none

call_event_event

{
  "call_id": "string",
  "event_type": "call_started",
  "participant": {
    "avatar": {
      "original": "string",
      "thumb": "string"
    },
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
call_id string false none none
event_type string false none none
participant brief_userV1 false none none

Enumerated Values

Property Value
event_type call_started
event_type call_ended
event_type participant_joined
event_type participant_left

call_event_message

{
  "from": {
    "avatar": {
      "original": "string",
      "thumb": "string"
    },
    "id": 0,
    "name": "string"
  },
  "message": "string"
}

Properties

Name Type Required Restrictions Description
from brief_userV1 false none none
message string false none none

call_event_request

{
  "from": {
    "avatar": {
      "original": "string",
      "thumb": "string"
    },
    "id": 0,
    "name": "string"
  },
  "is_group": true,
  "reason": "string",
  "to": {
    "avatar": {
      "original": "string",
      "thumb": "string"
    },
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
from brief_userV1 false none none
is_group boolean false none none
reason string false none none
to brief_userV1 false none none

call_event_stream

{
  "data": {
    "from": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "is_group": true,
    "reason": "string",
    "to": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "call_id": "string",
    "event_type": "call_started",
    "participant": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "message": "string",
    "creator": {
      "avatar": {
        "original": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    },
    "deleted": true,
    "id": 0,
    "mime_type": "string",
    "name": "string",
    "path": "string",
    "progress": 0,
    "signed_url": "string",
    "status": "unknown",
    "thumbnail": "string",
    "timestamp": 0,
    "type": "string"
  },
  "datetime": "2019-08-24T14:15:22Z",
  "type": "request"
}

Properties

Name Type Required Restrictions Description
data any false none none

allOf

Name Type Required Restrictions Description
» anonymous call_event_request false none none

and

Name Type Required Restrictions Description
» anonymous call_event_event false none none

and

Name Type Required Restrictions Description
» anonymous call_event_message false none none

and - discriminator: call_attachmentV1.id

Name Type Required Restrictions Description
» anonymous call_attachmentV1 false none none

continued

Name Type Required Restrictions Description
datetime string(date-time) false none ISO8601 DateTime
type string false none none

Enumerated Values

Property Value
type request
type event
type message
type attachment

call_ratings

{
  "participant_id": "string",
  "rating": "string"
}

Properties

Name Type Required Restrictions Description
participant_id string false none none
rating string false none none

call_survey

{
  "name": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
name string false none Survey name
url string false none Url of survey

call_tag

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none Call tag identifier
name string false none tag name

colleagues

{
  "entries": [
    {
      "active": true,
      "available": "string",
      "avatar": "string",
      "confirmed_email": true,
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "permissions": [
        "string"
      ],
      "personal_room_session_id": "string",
      "personal_room_url": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [user] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

comments_creator

{
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "id": 0,
  "name": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
avatar avatarV1 false none User's avatar URL
id integer(int32) false none User identifier
name string false none Display name of user
username string false none Username of user

contactV1

{
  "available": "string",
  "avatar": "string",
  "circles": [
    "string"
  ],
  "email": "string",
  "favorite": true,
  "id": 0,
  "name": "string",
  "status": "string",
  "token": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
available string false none Whether the contact is available (ONLINE, BUSY, IDLE).
avatar string false none Avatar URL of contact
circles [string] false none Our circles that this contact is in.
email string false none Email of contact
favorite boolean false none Whether or not contact is favorited
id integer(int32) false none Unique identifier for the contact
name string false none Name of contact
status string false none Status of contact
token string false none Token for further actions on the contact.
username string false none Username of contact

contactV1R1

{
  "avatar": {
    "timestamp": "2019-08-24T14:15:22Z",
    "url": "string"
  },
  "favorite": true,
  "id": 0,
  "license": "string",
  "location": "string",
  "name": "string",
  "reachable": true,
  "supports_messaging": true,
  "title": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
avatar object false none none
» timestamp string(date-time) false none Timestamp when the avatar last changed
» url string false none URL of the avatar image
favorite boolean false none Whether or not this contact has been favorited
id integer(int32) false none User identifier
license string false none License of the contact
location string false none Location of the contact
name string false none Name of the contact
reachable boolean false none Whether or not this contact is reachable
supports_messaging boolean false none Whether or not this contact supports messaging
title string false none Title of the contact
username string false none Username of the contact

contact_request_incoming

{
  "avatar": "string",
  "id": 0,
  "name": "string",
  "requestee_email": "string",
  "requestee_name": "string",
  "status": "string",
  "user_exists": true,
  "username": "string"
}

Properties

Name Type Required Restrictions Description
avatar string false none Avatar URL of requestor.
id integer(int32) false none Identifier of the contact request.
name string false none Name of requestor.
requestee_email string false none Email of requestee.
requestee_name string false none Name of requestee.
status string false none Status of the contact request.
user_exists boolean false none Whether or not the requestee exists in the system yet.
username string false none Username of requestor.

contact_request_outgoing

{
  "avatar": "string",
  "id": 0,
  "name": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
avatar string false none Avatar URL of requestee.
id integer(int32) false none Identifier of the contact request.
name string false none Name of requestee.
username string false none Username of requestee.

contact_requests_incoming

{
  "entries": [
    {
      "avatar": "string",
      "id": 0,
      "name": "string",
      "requestee_email": "string",
      "requestee_name": "string",
      "status": "string",
      "user_exists": true,
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [contact_request_incoming] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

contact_requests_outgoing

{
  "entries": [
    {
      "avatar": "string",
      "id": 0,
      "name": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [contact_request_outgoing] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

contactsV1

{
  "entries": [
    {
      "available": "string",
      "avatar": "string",
      "circles": [
        "string"
      ],
      "email": "string",
      "favorite": true,
      "id": 0,
      "name": "string",
      "status": "string",
      "token": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [contactV1] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

contactsV1R1

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "favorite": true,
      "id": 0,
      "license": "string",
      "location": "string",
      "name": "string",
      "reachable": true,
      "supports_messaging": true,
      "title": "string",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [contactV1R1] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

domain_brief

{
  "company": "string",
  "id": 0,
  "mailbag": "string",
  "mode": "string",
  "name": "string",
  "standard": true
}

Properties

Name Type Required Restrictions Description
company string false none none
id integer(int32) false none none
mailbag string false none none
mode string false none none
name string false none none
standard boolean false none none

enterpriseV1

{
  "active": true,
  "active_user_count": 0,
  "auto_accept": true,
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "description": "string",
  "domains": [
    "string"
  ],
  "id": 0,
  "lock_devices": true,
  "max_users": "string",
  "name": "string",
  "time_zone": "string",
  "token": "string",
  "translation_file_url": "string",
  "user_count": 0
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether or not the enterprise account is active for use
active_user_count integer(int32) false none Total number of active users currently in the enterprise
auto_accept boolean false none Whether or not to auto-accept invitations to emails in the domains list.
branding_locked boolean false none Whether or not branding can be enabled for this enterprise
contact_email string false none Enterprise contact email
contact_name string false none Enterprise contact name
contact_phone string false none Enterprise contact phone number
description string false none The enterprise's description
domains [string] false none List of approved domains owned by this enterprise for auto-accept.
id integer(int32) false none Identifier of the enterprise
lock_devices boolean false none Whether or not devices are site locked to this enterprise
max_users string false none Maximum allowed users in the enterprise
name string false none Name of the enterprise
time_zone string false none Enterprise's time zone
token string false none Token for further actions on the enterprise.
translation_file_url string false none The enterprise's translation file url
user_count integer(int32) false none Total number of users currently in the enterprise

enterpriseV1R1

{
  "auto_accept": true,
  "aws_credentials": {
    "access_key_id": "string",
    "cloudfront_url": "string",
    "s3_bucket": "string",
    "s3_cookie_expiration": 0,
    "s3_cookie_key_id": "string",
    "s3_cookie_policy": "string",
    "s3_cookie_signature": "string",
    "s3_organization_base_path": "string",
    "s3_region": "string",
    "secret_access_key": "string",
    "session_token": "string"
  },
  "branding_locked": true,
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "default_pod_id": 0,
  "delete_users_upon_declination_of_disclaimer": true,
  "description": "string",
  "disable_agent_camera_in_call_center_mode": true,
  "domain": {
    "company": "string",
    "id": 0,
    "mailbag": "string",
    "mode": "string",
    "name": "string",
    "standard": true
  },
  "domains": [
    "string"
  ],
  "expert_on_call_notification_email": "string",
  "features": [
    {
      "description": "string",
      "id": 0,
      "name": "string",
      "var": "string"
    }
  ],
  "id": 0,
  "name": "string",
  "password_policy": {
    "password_required_description": "string",
    "rules": [
      {
        "regex": "string",
        "required": "string",
        "text": "string",
        "type": "string"
      }
    ]
  },
  "recording_retention_days": 0,
  "retention_policy_days": 0,
  "session_link_expiration_hours": 0,
  "session_link_max_lifetime_days": 0,
  "subscription": {
    "active": true,
    "billing_day": 0,
    "canceled_at": "string",
    "card_last4": "string",
    "card_type": "string",
    "delinquent": true,
    "delinquent_at": "string",
    "id": 0,
    "mobile_users": 0,
    "monthly_base_cost": 0.1,
    "subscription_end": "string",
    "trial_end": "string"
  },
  "survey_url": "string",
  "time_zone": "string",
  "translation_file_url": "string",
  "user_count": 0,
  "watermark_enabled": true,
  "workbox_enabled": true
}

Properties

Name Type Required Restrictions Description
auto_accept boolean false none Whether or not to auto-accept invitations to emails in the domains list.
aws_credentials object false none none
» access_key_id string false none AWS Access Key ID
» cloudfront_url string false none Cloudfront URL
» s3_bucket string false none S3 Bucket
» s3_cookie_expiration integer false none S3 Expiration (In Seconds)
» s3_cookie_key_id string false none S3 Cookie ID
» s3_cookie_policy string false none S3 Policy Cookie
» s3_cookie_signature string false none S3 Signature Cookie
» s3_organization_base_path string false none S3 Bucket Prefix
» s3_region string false none Region of the bucket
» secret_access_key string false none AWS Secret Access Key
» session_token string false none AWS Session Token
branding_locked boolean false none Whether or not branding can be enabled for this enterprise
contact_email string false none Enterprise contact email
contact_name string false none Enterprise contact name
contact_phone string false none Enterprise contact phone number
default_pod_id integer(int32) false none ID of the default pod for the enterprise
delete_users_upon_declination_of_disclaimer boolean false none Delete users upon disclaimer
description string false none Description of the enterprise
disable_agent_camera_in_call_center_mode boolean false none Whether or not to disable the camera in call center mode
domain domain_brief false none none
domains [string] false none List of approved domains owned by this enterprise for auto-accept.
expert_on_call_notification_email string false none Email for the notification about no one on call for the enterprise
features [permission] false none none
id integer(int32) false none Identifier of the enterprise
name string false none Name of the enterprise
password_policy password_policyV1 false none none
recording_retention_days integer(int32) false none How many days to retain call data
retention_policy_days integer(int32) false none How many days to retain call data
session_link_expiration_hours integer(int32) false none one time link expired hours after clicked
session_link_max_lifetime_days integer(int32) false none one time link expired days when not clicked
subscription subscriptionV1 false none none
survey_url string false none The enterprise's survey url.
time_zone string false none Enterprise's time zone
translation_file_url string false none Base path to custom field translations
user_count integer(int32) false none Total number of users currently in the enterprise
watermark_enabled boolean false none Whether or not to disable the watermark in call
workbox_enabled boolean false none Whether or not to disable the workbox in workspace

enterprise_admin

{
  "email": "string",
  "id": 0,
  "name": "string",
  "parent_id": 0
}

Properties

Name Type Required Restrictions Description
email string false none Email of user
id integer(int32) false none User identifier
name string false none Display of user
parent_id integer(int32) false none Parent User identifier

enterprise_apikey

{
  "access_token": "string",
  "description": "string",
  "id": 0
}

Properties

Name Type Required Restrictions Description
access_token string false none The apikey
description string false none The description
id integer(int32) false none The apikey ID

enterprise_apikeys

{
  "entries": [
    {
      "access_token": "string",
      "description": "string",
      "id": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_apikey] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

enterprise_call_brief

{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "call_duration": 0,
  "call_id": "string",
  "dialer": {
    "email": "string",
    "enterprise_id": 0,
    "id": 0,
    "is_anonymous": true,
    "name": "string",
    "username": "string"
  },
  "extra_info": "string",
  "has_attachments": true,
  "intra_enterprise_call": true,
  "owner_email": "string",
  "owner_id": "string",
  "owner_name": "string",
  "participants": [
    {
      "email": "string",
      "enterprise_id": 0,
      "id": 0,
      "is_anonymous": true,
      "name": "string",
      "username": "string"
    }
  ],
  "reason_call_ended": "string",
  "time_call_ended": 0,
  "time_call_started": 0,
  "timestamp": "string"
}

Properties

Name Type Required Restrictions Description
alt1_id string false none none
alt2_id string false none none
alt3_id string false none none
call_duration integer false none Duration of the call in seconds
call_id string false none none
dialer enterprise_call_user false none none
extra_info string false none none
has_attachments boolean false none none
intra_enterprise_call boolean false none none
owner_email string false none none
owner_id string false none none
owner_name string false none none
participants [enterprise_call_user] false none none
reason_call_ended string false none none
time_call_ended number false none none
time_call_started number false none none
timestamp string false none none

enterprise_call_user

{
  "email": "string",
  "enterprise_id": 0,
  "id": 0,
  "is_anonymous": true,
  "name": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
email string false none none
enterprise_id integer(int32) false none none
id integer(int32) false none none
is_anonymous boolean false none none
name string false none none
username string false none none

enterprise_disclaimer

{
  "delete_users_upon_declination_of_disclaimer": true,
  "enabled": true,
  "text": "string"
}

Properties

Name Type Required Restrictions Description
delete_users_upon_declination_of_disclaimer boolean false none Delete users upon disclaimer
enabled boolean false none Disclaimer enabled
text string false none Text of disclaimer

enterprise_invitationV1

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "personas": [
    "string"
  ],
  "pods": [
    "string"
  ],
  "status": "string",
  "user_exists": true
}

Properties

Name Type Required Restrictions Description
email string false none Email of user being invited.
enterprise_name string false none Name of enterprise.
id integer(int32) false none Identifier of the invitation.
invitation_sent_at string(date-time) false none none
name string false none Name of user being invited.
personas [string] false none Personas the user is invited to join
pods [string] false none Pods the user is invited to join
status string false none Status of the invitation.
user_exists boolean false none Whether or not the user exists.

enterprise_invitationV1R1

{
  "email": "string",
  "enterprise_name": "string",
  "id": 0,
  "invitation_sent_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "location": "string",
  "manage": true,
  "name": "string",
  "pods": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "user_exists": true
}

Properties

Name Type Required Restrictions Description
email string false none Email of user being invited.
enterprise_name string false none Name of enterprise.
id integer(int32) false none Identifier of the invitation.
invitation_sent_at string(date-time) false none none
license string false none License of the user (team or expert)
location string false none Location of the user
manage boolean false none Whether or not the invite can be managed by you
name string false none Name of user being invited.
pods [string] false none Names of pods the user is invited to join
status string false none Status of the invitation.
title string false none Title of the user
user_exists boolean false none Whether or not the user exists.

enterprise_invitations

{
  "entries": [
    {
      "email": "string",
      "enterprise_name": "string",
      "id": 0,
      "invitation_sent_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "personas": [
        "string"
      ],
      "pods": [
        "string"
      ],
      "status": "string",
      "user_exists": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_invitationV1] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

enterprise_partner_key

{
  "message": {
    "private": "string",
    "public": "string"
  },
  "success": true
}

Properties

Name Type Required Restrictions Description
message object false none none
» private string false none The PEM encode private key
» public string false none The PEM encoded public key
success boolean false none Whether the operation was successful

enterprise_partner_public_key

{
  "message": {
    "created_at": "2019-08-24T14:15:22Z",
    "description": "string",
    "enterprise_id": 0,
    "public_key": "string"
  },
  "success": true
}

Properties

Name Type Required Restrictions Description
message object false none none
» created_at string(date-time) false none none
» description string false none The description
» enterprise_id integer false none The enterprise id
» public_key string false none The PEM encoded public key
success boolean false none Whether the operation was successful

enterprise_partner_public_key2

{
  "success": true,
  "message": {
    "id": 0,
    "enterprise_id": 0,
    "public_key": "string",
    "private_key": "string",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

Properties

Name Type Required Restrictions Description
success boolean false none Whether the operation was successful
message object false none none
» id integer false none The partner key ID
» enterprise_id integer false none The enterprise id
» public_key string false none The PEM encoded public key
» private_key string false none The PEM encoded private key (Only returned upon creation)
» description string false none The description
» created_at string(date-time) false none none

enterprise_translation

[
  {
    "items": [
      {
        "language_iso": "string",
        "translation": "string"
      }
    ],
    "key_name": "string"
  }
]

Properties

Name Type Required Restrictions Description
items [object] false none none
» language_iso string false none language iso
» translation string false none translation value
key_name string false none Translation key name

enterprise_automation

{
  "id": 0,
  "name": "string",
  "injector_id": "string",
  "flow": "string",
  "public": true,
  "verb": "string",
  "inserted_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
id integer false none Automation id
name string false none Automation name
injector_id string false none Injector id
flow string false none Flow content
public boolean false none Public automation or not
verb string false none Automation verb
inserted_at string(date-time) false none Automation inserted at
updated_at string(date-time) false none Automation updated at

enterprise_user

{
  "active": true,
  "admin_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "appliance_registration_status": false,
  "available": true,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "current_sign_in_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "email_confirmed": true,
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "name": "string",
  "parent_id": 0,
  "permissions": [
    "string"
  ],
  "phone": "string",
  "pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "provider": "string",
  "provider_uid": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "username": "string",
  "visible_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "id": 0,
      "name": "string",
      "workspace_id": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether or not user account is active and able to make calls
admin_pods [object] false none none
» id integer(int32) false none Identifier of the pod
» name string false none Name of the pod
appliance_registration_status boolean false none The status of appliance registration
available boolean false none Available status of user (true / false)
avatar avatarV1 false none User's avatar URL
created_at string(date-time) false none none
current_sign_in_at string(date-time) false none The date time of user sign in
email string false none Email of user
email_confirmed boolean false none Whether or not the accounts requested email is confirmed
id integer(int32) false none User identifier
is_confirmed boolean false none Whether or not the user account is confirmed for login
is_first_login boolean false none Whether or not the user has logged in for the first time
last_used_at string(date-time) false none Last time this user account was used in the app
license string false none License of the user (team or expert)
name string false none name of user
parent_id integer false none The id of the parent of this alias user
permissions [string] false none List of permissions for this user account
phone string false none Phone number of user
pods [object] false none none
» id integer(int32) false none Identifier of the pod
» name string false none Name of the pod
provider string false none The OAuth provider
provider_uid string false none The OAuth provider's uid for this user
role_id integer false none The user's role ID
role_name string false none The user's role
status string false none Status of the user (Registered, Invited)
status_message string false none Status message of contact
token string false none Token for further actions on the contact.
unavailable_expires_at string(date-time) false none When the unavailable status expires, as a timestamp
username string false none Username of user
visible_pods [object] false none none
» id integer(int32) false none Identifier of the pod
» name string false none Name of the pod
workspaces [object] false none none
» id integer(int32) false none ID of the workspace user
» name string false none Name of the workspace
» workspace_id integer(int32) false none ID of the workspace

enterprise_users

{
  "entries": [
    {
      "active": true,
      "admin_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "appliance_registration_status": false,
      "available": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "current_sign_in_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "email_confirmed": true,
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "license": "string",
      "name": "string",
      "parent_id": 0,
      "permissions": [
        "string"
      ],
      "phone": "string",
      "pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "provider": "string",
      "provider_uid": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "username": "string",
      "visible_pods": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "workspaces": [
        {
          "id": 0,
          "name": "string",
          "workspace_id": 0
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_user] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

enterprise_webhook

{
  "event": "string",
  "event_filter": "string",
  "id": 0,
  "webhook": "string"
}

Properties

Name Type Required Restrictions Description
event string false none The event the webhook is registered for
event_filter string false none A regex of subevents to filter out
id integer(int32) false none The webhook ID
webhook string false none The URL of the webhook that the event will be delivered to

enterprise_webhooks

{
  "entries": [
    {
      "event": "string",
      "event_filter": "string",
      "id": 0,
      "webhook": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_webhook] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

enterprise_workboxV1

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_at": "string",
  "created_by": "string",
  "custom_fields": [
    {
      "name": "string",
      "status": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "description": "string",
  "duration": 0,
  "id": 0,
  "status": "string",
  "ticket_id": 0,
  "ticket_type": "string"
}

Properties

Name Type Required Restrictions Description
assigned_at string false none Time of ticket assigned
closed_at string false none Time of ticket closed
created_at string false none Time of ticket created
created_by string false none Name of ticket created
custom_fields [object] false none none
» name string false none Name of the Custom Field
» status string false none Status of the Custom Field
» type string false none Type of the Custom Field
» value string false none Value of the Custom Field
description string false none Ticket description
duration integer false none Time of ticket duration
id integer(int32) false none Workbox identifier
status string false none Ticket status
ticket_id integer(int32) false none Ticket identifier
ticket_type string false none Ticket type

enterprise_workboxes_report

{
  "close_at": "string",
  "create_at": "string",
  "custom_fields": [
    {
      "name": "string",
      "status": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "description": "string",
  "duration": 0,
  "owner": "string",
  "owner_email": "string",
  "owner_groups": [
    {}
  ],
  "owner_location": "string",
  "owner_title": "string",
  "participants": [
    {}
  ],
  "status": "string",
  "ticket_id": 0
}

Properties

Name Type Required Restrictions Description
close_at string false none Time of ticket closed
create_at string false none Time of ticket created
custom_fields [object] false none none
» name string false none Name of the Custom Field
» status string false none Status of the Custom Field
» type string false none Type of the Custom Field
» value string false none Value of the Custom Field
description string false none Ticket description
duration integer false none Time of ticket duration
owner string false none Name of owner
owner_email string false none Email of owner
owner_groups [object] false none none
owner_location string false none location of owner
owner_title string false none Title of owner
participants [object] false none none
status string false none Ticket status
ticket_id integer(int32) false none Ticket identifier

enterprise_workboxes_reports

{
  "entries": [
    {
      "close_at": "string",
      "create_at": "string",
      "custom_fields": [
        {
          "name": "string",
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "description": "string",
      "duration": 0,
      "owner": "string",
      "owner_email": "string",
      "owner_groups": [
        {}
      ],
      "owner_location": "string",
      "owner_title": "string",
      "participants": [
        {}
      ],
      "status": "string",
      "ticket_id": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_workboxes_report] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

enterprise_workspace

{
  "active": true,
  "admins": [
    {
      "email": "string",
      "id": 0,
      "name": "string",
      "parent_id": 0
    }
  ],
  "id": 0,
  "name": "string",
  "token": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none The workspace active status
admins array false none A List of users in this workspace whose role is EnterpriseAdmin
id integer(int32) false none The workspaces ID
name string false none The name of workspaces
token string false none The token of workspaces

enterprise_workspace_call_tag

{
  "id": 0,
  "name": "string",
  "workspace_id": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none Call tag identifier
name string false none tag name
workspace_id integer(int32) false none The workspace ID

enterprise_workspace_group

{
  "id": 0,
  "name": "string",
  "workspace_id": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none Group identifier
name string false none group name
workspace_id integer(int32) false none The workspace ID

enterprise_workspaces

{
  "entries": [
    {
      "active": true,
      "admins": [
        {
          "email": "string",
          "id": 0,
          "name": "string",
          "parent_id": 0
        }
      ],
      "id": 0,
      "name": "string",
      "token": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_workspace] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

enterprises

{
  "entries": [
    {
      "active": true,
      "active_user_count": 0,
      "auto_accept": true,
      "branding_locked": true,
      "contact_email": "string",
      "contact_name": "string",
      "contact_phone": "string",
      "description": "string",
      "domains": [
        "string"
      ],
      "id": 0,
      "lock_devices": true,
      "max_users": "string",
      "name": "string",
      "time_zone": "string",
      "token": "string",
      "translation_file_url": "string",
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterpriseV1] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

errorV1

{
  "code": 0,
  "message": "string"
}

Properties

Name Type Required Restrictions Description
code integer(int32) false none none
message string false none none

errorV1R1

{
  "code": 0,
  "message": "string",
  "name": "generic"
}

Properties

Name Type Required Restrictions Description
code integer(int32) false none Error code, as an integer
message string false none Reason for the error
name string false none The name of the error. This is meant to be a more human-readable name than the integer code.

Enumerated Values

Property Value
name generic
name timeout
name auth
name authentication
name authorization
name invalid_apikey
name missing_apikey
name session
name session_invalid
name method
name method_invalid
name method_parameters_invalid
name already_confirmed
name email_taken
name existing_contact
name expired_token
name image_size_over_limit
name invalid_email
name invalid_image
name invalid_name
name invalid_password
name invalid_search_term
name invalid_status
name invalid_username
name unknown_email
name unknown_contact_request
name unknown_push_id
name unknown_registration
name username_taken
name invalid_tag
name incorrect_password
name unknown_device_platform
name unknown_device_state
name invalid_limit
name existing_contact_request
name contact_request_direction
name contact_request_action
name invalid_pin
name unknown_contact
name account_deactivated
name invalid_token
name data_unavailable
name account_unconfirmed
name invalid_room
name unknown_device_id
name invalid_message
name invalid_number
name non_mobile_number
name blacklist
name link_expired
name unknown_reset_password_token
name constraint
name not_found

features

[
  {
    "enabled": true,
    "name": "string"
  }
]

Properties

Name Type Required Restrictions Description
enabled boolean false none Enabled of the feature
name string false none Name of the feature

get_help_response

{
  "request_id": "string",
  "sesseion_auth": {
    "gss_info": {
      "server": "string",
      "token": "string",
      "wsserver": "string"
    },
    "session_info": {
      "id": "string",
      "pin": "string",
      "token": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "users": [
        "string"
      ],
      "video_active": true
    }
  }
}

Properties

Name Type Required Restrictions Description
request_id string false none The Request ID
sesseion_auth object false none none
» gss_info object false none none
»» server string false none The Gss server URL to connect to
»» token string false none A Session token for use with Gss
»» wsserver string false none The Gss websocket server URL to connect to
» session_info object false none none
»» id string false none The Session ID
»» pin string false none PIN code (not used)
»» token string false none A Session token for use with Gss
»» updated_at string(date-time) false none The last time this session was updated
»» users [string] false none List of users in the session
»» video_active boolean false none Whether or not there is already active video in this session

group

{
  "avatar": {
    "timestamp": "2019-08-24T14:15:22Z",
    "url": "string"
  },
  "description": "string",
  "enterprise_id": 0,
  "favorite": true,
  "id": 0,
  "name": "string",
  "on_call_group": true
}

Properties

Name Type Required Restrictions Description
avatar object false none none
» timestamp string(date-time) false none Timestamp when the avatar last changed
» url string false none URL of the avatar image
description string false none Description of the group
enterprise_id integer(int32) false none Enterprise ID that this group is part of
favorite boolean false none Whether or not this group has been favorited
id integer(int32) false none Group identifier
name string false none Name of the group
on_call_group boolean false none Whether or not this is an on-call group (always true)

groups

{
  "entries": [
    {
      "avatar": {
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "description": "string",
      "enterprise_id": 0,
      "favorite": true,
      "id": 0,
      "name": "string",
      "on_call_group": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [group] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

hermes_call

{
  "alt1_id": "string",
  "alt2_id": "string",
  "alt3_id": "string",
  "callDuration": 0,
  "dialderId": "string",
  "dialer": {
    "email": "string",
    "enterpriseId": "string",
    "id": "string",
    "name": "string",
    "username": "string"
  },
  "dialerName": "string",
  "extra_info": "string",
  "has_attachments": true,
  "intraEnterpriseCall": true,
  "owner_email": "string",
  "owner_id": "string",
  "owner_name": "string",
  "participants": [
    {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "isAnonymous": true,
      "name": "string",
      "username": "string"
    }
  ],
  "ratings": [
    {
      "participant_id": "string",
      "rating": "string"
    }
  ],
  "reasonCallEnded": "string",
  "receiver": {
    "email": "string",
    "enterpriseId": "string",
    "id": "string",
    "name": "string",
    "username": "string"
  },
  "receiverId": "string",
  "receiverName": "string",
  "recordingError": "string",
  "recordingStatus": "string",
  "recordingUrl": "string",
  "session": "string",
  "tags": [
    "string"
  ],
  "timeCallEnded": 0,
  "timeCallStarted": 0,
  "timestamp": "string",
  "workbox_id": 0,
  "workbox_v2_id": 0
}

Properties

Name Type Required Restrictions Description
alt1_id string false none none
alt2_id string false none none
alt3_id string false none none
callDuration integer false none Duration of the call in seconds
dialderId string false none none
dialer hermes_call_user false none none
dialerName string false none none
extra_info string false none none
has_attachments boolean false none none
intraEnterpriseCall boolean false none none
owner_email string false none none
owner_id string false none none
owner_name string false none none
participants [hermes_call_participant] false none none
ratings [call_ratings] false none List of ratings
reasonCallEnded string false none none
receiver hermes_call_user false none none
receiverId string false none none
receiverName string false none none
recordingError string false none none
recordingStatus string false none none
recordingUrl string false none none
session string false none none
tags [string] false none List of tags
timeCallEnded number false none none
timeCallStarted number false none none
timestamp string false none none
workbox_id integer(int32) false none none
workbox_v2_id integer(int32) false none none

hermes_call_event

{
  "call": {
    "callDuration": 0,
    "callId": "string",
    "dialerId": "string",
    "dialerName": "string",
    "galdrSession": "string",
    "intraEnterpriseCall": true,
    "lastEvaluatedTimestamp": 0,
    "openTokSession": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiverId": "string",
    "receiverName": "string",
    "recordingBucket": "string",
    "recordingError": "string",
    "recordingPath": "string",
    "recordingStatus": "string",
    "session": "string",
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": 0
  },
  "error": true,
  "stats": {
    "overallQuality": 0,
    "participantStats": [
      {
        "ended": {
          "appVersion": "string",
          "deviceType": "string",
          "deviceVersion": "string",
          "networkType": "string",
          "reason": "string",
          "timestamp": 0
        },
        "enterpriseId": "string",
        "id": "string",
        "isDialer": true,
        "name": "string",
        "network": {
          "avgQuality": 0,
          "avgResult": "string",
          "bandwidth": [
            {
              "audio": 0,
              "result": "string",
              "timestamp": 0,
              "video": 0
            }
          ],
          "packetLoss": [
            {
              "audio": 0,
              "result": "string",
              "timestamp": 0,
              "video": 0
            }
          ]
        },
        "started": {
          "appVersion": "string",
          "deviceType": "string",
          "deviceVersion": "string",
          "networkType": "string",
          "timestamp": 0
        }
      }
    ],
    "session": "string",
    "timestamp": 0
  }
}

Properties

Name Type Required Restrictions Description
call object false none none
» callDuration integer false none none
» callId string false none none
» dialerId string false none none
» dialerName string false none none
» galdrSession string false none none
» intraEnterpriseCall boolean false none none
» lastEvaluatedTimestamp integer false none none
» openTokSession string false none none
» participants [hermes_call_participant] false none none
» reasonCallEnded string false none none
» receiverId string false none none
» receiverName string false none none
» recordingBucket string false none none
» recordingError string false none none
» recordingPath string false none none
» recordingStatus string false none none
» session string false none none
» timeCallEnded number false none none
» timeCallStarted number false none none
» timestamp integer false none none
error boolean false none none
stats object false none none
» overallQuality number false none none
» participantStats [object] false none none
»» ended object false none none
»»» appVersion string false none none
»»» deviceType string false none none
»»» deviceVersion string false none none
»»» networkType string false none none
»»» reason string false none none
»»» timestamp integer false none none
»» enterpriseId string false none none
»» id string false none none
»» isDialer boolean false none none
»» name string false none none
»» network object false none none
»»» avgQuality number false none none
»»» avgResult string false none none
»»» bandwidth [object] false none none
»»»» audio integer false none none
»»»» result string false none none
»»»» timestamp integer false none none
»»»» video integer false none none
»»» packetLoss [object] false none none
»»»» audio integer false none none
»»»» result string false none none
»»»» timestamp integer false none none
»»»» video integer false none none
»» started object false none none
»»» appVersion string false none none
»»» deviceType string false none none
»»» deviceVersion string false none none
»»» networkType string false none none
»»» timestamp integer false none none
» session string false none none
» timestamp integer false none none

hermes_call_participant

{
  "email": "string",
  "enterpriseId": "string",
  "id": "string",
  "isAnonymous": true,
  "name": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
email string false none none
enterpriseId string false none none
id string false none none
isAnonymous boolean false none none
name string false none none
username string false none none

hermes_call_stats

{
  "stats": {
    "activeUsersPastWeek": [
      {
        "doc_count": "string",
        "key": "string"
      }
    ],
    "callLengthsPastWeek": [
      0
    ],
    "callsLastWeek": 0,
    "callsPerDay": [
      {
        "x": 0,
        "y": 0
      }
    ],
    "callsThisMonth": 0,
    "callsToday": 0,
    "totalUsers": 0
  }
}

Properties

Name Type Required Restrictions Description
stats object false none none
» activeUsersPastWeek [object] false none none
»» doc_count string false none none
»» key string false none none
» callLengthsPastWeek [integer] false none none
» callsLastWeek integer false none none
» callsPerDay [object] false none none
»» x number false none none
»» y number false none none
» callsThisMonth integer false none none
» callsToday integer false none none
» totalUsers integer false none none

hermes_call_user

{
  "email": "string",
  "enterpriseId": "string",
  "id": "string",
  "name": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
email string false none none
enterpriseId string false none none
id string false none none
name string false none none
username string false none none

hermes_enterprise_calls

[
  {
    "alt1_id": "string",
    "alt2_id": "string",
    "alt3_id": "string",
    "callDuration": 0,
    "dialderId": "string",
    "dialer": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "dialerName": "string",
    "extra_info": "string",
    "has_attachments": true,
    "intraEnterpriseCall": true,
    "owner_email": "string",
    "owner_id": "string",
    "owner_name": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "ratings": [
      {
        "participant_id": "string",
        "rating": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiver": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "receiverId": "string",
    "receiverName": "string",
    "recordingError": "string",
    "recordingStatus": "string",
    "recordingUrl": "string",
    "session": "string",
    "tags": [
      "string"
    ],
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": "string",
    "workbox_id": 0,
    "workbox_v2_id": 0
  }
]

Properties

Name Type Required Restrictions Description
anonymous [hermes_call] false none none

hermes_enterprise_report

{
  "csv": "string",
  "error": "string",
  "response": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
csv string false none none
error string false none none
response [string] false none none

hermes_paginated_enterprise_calls

{
  "entries": [
    {
      "alt1_id": "string",
      "alt2_id": "string",
      "alt3_id": "string",
      "callDuration": 0,
      "dialderId": "string",
      "dialer": {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "name": "string",
        "username": "string"
      },
      "dialerName": "string",
      "extra_info": "string",
      "has_attachments": true,
      "intraEnterpriseCall": true,
      "owner_email": "string",
      "owner_id": "string",
      "owner_name": "string",
      "participants": [
        {
          "email": "string",
          "enterpriseId": "string",
          "id": "string",
          "isAnonymous": true,
          "name": "string",
          "username": "string"
        }
      ],
      "ratings": [
        {
          "participant_id": "string",
          "rating": "string"
        }
      ],
      "reasonCallEnded": "string",
      "receiver": {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "name": "string",
        "username": "string"
      },
      "receiverId": "string",
      "receiverName": "string",
      "recordingError": "string",
      "recordingStatus": "string",
      "recordingUrl": "string",
      "session": "string",
      "tags": [
        "string"
      ],
      "timeCallEnded": 0,
      "timeCallStarted": 0,
      "timestamp": "string",
      "workbox_id": 0,
      "workbox_v2_id": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [hermes_call] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

hermes_pod_stats

{
  "stats": {
    "callsLastWeek": 0,
    "callsThisMonth": 0,
    "callsToday": 0
  }
}

Properties

Name Type Required Restrictions Description
stats object false none none
» callsLastWeek integer false none none
» callsThisMonth integer false none none
» callsToday integer false none none

hermes_session_call

{
  "callDuration": 0,
  "callId": "string",
  "dialderId": "string",
  "dialerName": "string",
  "galdrSession": "string",
  "intraEnterpriseCall": true,
  "lastEvaluatedTimestamp": 0,
  "openTokSession": "string",
  "participants": [
    {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "isAnonymous": true,
      "name": "string",
      "username": "string"
    }
  ],
  "reasonCallEnded": "string",
  "receiverId": "string",
  "receiverName": "string",
  "recordingBucket": "string",
  "recordingError": "string",
  "recordingPath": "string",
  "recordingStatus": "string",
  "session": "string",
  "timeCallEnded": 0,
  "timeCallStarted": 0,
  "timestamp": "string"
}

Properties

Name Type Required Restrictions Description
callDuration integer false none Duration of the call in seconds
callId string false none none
dialderId string false none none
dialerName string false none none
galdrSession string false none none
intraEnterpriseCall boolean false none none
lastEvaluatedTimestamp integer false none none
openTokSession string false none none
participants [hermes_call_participant] false none none
reasonCallEnded string false none none
receiverId string false none none
receiverName string false none none
recordingBucket string false none none
recordingError string false none none
recordingPath string false none none
recordingStatus string false none none
session string false none none
timeCallEnded number false none none
timeCallStarted number false none none
timestamp string false none none

hermes_user_calls

[
  {
    "alt1_id": "string",
    "alt2_id": "string",
    "alt3_id": "string",
    "callDuration": 0,
    "dialderId": "string",
    "dialer": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "dialerName": "string",
    "extra_info": "string",
    "has_attachments": true,
    "intraEnterpriseCall": true,
    "owner_email": "string",
    "owner_id": "string",
    "owner_name": "string",
    "participants": [
      {
        "email": "string",
        "enterpriseId": "string",
        "id": "string",
        "isAnonymous": true,
        "name": "string",
        "username": "string"
      }
    ],
    "ratings": [
      {
        "participant_id": "string",
        "rating": "string"
      }
    ],
    "reasonCallEnded": "string",
    "receiver": {
      "email": "string",
      "enterpriseId": "string",
      "id": "string",
      "name": "string",
      "username": "string"
    },
    "receiverId": "string",
    "receiverName": "string",
    "recordingError": "string",
    "recordingStatus": "string",
    "recordingUrl": "string",
    "session": "string",
    "tags": [
      "string"
    ],
    "timeCallEnded": 0,
    "timeCallStarted": 0,
    "timestamp": "string",
    "workbox_id": 0,
    "workbox_v2_id": 0
  }
]

Properties

Name Type Required Restrictions Description
anonymous [hermes_call] false none none

invitations

{
  "entries": [
    {
      "email": "string",
      "enterprise_name": "string",
      "id": 0,
      "invitation_sent_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "personas": [
        "string"
      ],
      "pods": [
        "string"
      ],
      "status": "string",
      "user_exists": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_invitationV1] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none 

{
  "creator": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "status": 0,
    "username": "string"
  },
  "session": {
    "id": "string",
    "pin": "string",
    "token": "string",
    "updated_at": "string",
    "users": [
      {
        "avatar": {
          "full": "string",
          "thumb": "string"
        },
        "id": 0,
        "name": "string",
        "status": 0,
        "token": "string",
        "username": "string"
      }
    ],
    "video_active": true
  },
  "workflow": 0
}

Properties

Name Type Required Restrictions Description
creator link_user false none none
session link_session false none none
workflow integer false none - 0 : Default. Send video request: 'POST session/video'
- 1 : Call 'GET session/auth' first, then join to GSS.

Enumerated Values

Property Value
workflow 0
workflow 1 

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string",
      "status": 0,
      "token": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Properties

Name Type Required Restrictions Description
id string false none Session ID
pin string false none A PIN that guests can use to enter the session
token string false none A Session Token
updated_at string false none A date string when this was last updated
users [object] false none none
» avatar avatarV1 false none none
» id integer false none User's ID
» name string false none User's display name
» status integer false none Users status
» token string false none User's public token
» username string false none User's username
video_active boolean false none Whether users are actively in the video session 

{
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "id": 0,
  "status": 0,
  "username": "string"
}

Properties

Name Type Required Restrictions Description
avatar avatarV1 false none none
id integer false none none
status integer false none none
username string false none none

on_call_group

{
  "avatar": "string",
  "description": "string",
  "enterprise_id": 0,
  "favorite": true,
  "id": 0,
  "name": "string",
  "on_call_group": true
}

Properties

Name Type Required Restrictions Description
avatar string false none Pod's Avatar URL for dashboard.
description string false none Description of the pod
enterprise_id integer(int32) false none Enterprise Identifier of the pod
favorite boolean false none Whether or not this is a favorite
id integer(int32) false none Identifier of the pod
name string false none Name of the pod
on_call_group boolean false none Whether or not this is an on call group

on_call_groups

{
  "entries": [
    {
      "avatar": "string",
      "description": "string",
      "enterprise_id": 0,
      "favorite": true,
      "id": 0,
      "name": "string",
      "on_call_group": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [on_call_group] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

participant

{
  "email": "string",
  "enterpriseId": 0,
  "id": "string",
  "isAnonymous": true,
  "location": "string",
  "name": "string",
  "title": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
email string false none none
enterpriseId integer(int32) false none none
id string false none none
isAnonymous boolean false none none
location string false none none
name string false none none
title string false none none
username string false none none

password_policyV1

{
  "password_required_description": "string",
  "rules": [
    {
      "regex": "string",
      "required": "string",
      "text": "string",
      "type": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
password_required_description string false none A string that describes the password requirements
rules [object] false none List of rules that govern the password policy
» regex string false none A regular expression to validate the rule
» required string false none Whether or not this rule is required for a valid password
» text string false none A string that describes the rule
» type string false none The type of the rule. Only 'regex' is currently supported.

permission

{
  "description": "string",
  "id": 0,
  "name": "string",
  "var": "string"
}

Properties

Name Type Required Restrictions Description
description string false none Description of the permission
id integer(int32) false none The ID for the permission
name string false none Name of permission
var string false none Human-readable unique identifier of the permission

persona

{
  "avatar": "string",
  "color": "string",
  "description": "string",
  "id": 0,
  "name": "string",
  "user_count": 0
}

Properties

Name Type Required Restrictions Description
avatar string false none Persona's Avatar URL for dashboard.
color string false none Persona's color for dashboard.
description string false none Description of the persona
id integer(int32) false none Identifier of the persona
name string false none Name of the persona
user_count integer(int32) false none Number of users in the persona

personal_access_token

{
  "description": "string",
  "id": 0,
  "token": "string"
}

Properties

Name Type Required Restrictions Description
description string false none Human readable description of the token
id integer(int32) false none Unique ID for the personal access token
token string false none Encoded for the personal access token used for authentication

personal_user

{
  "active": true,
  "admin_pods": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "auth_type": "string",
  "available": true,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "email_confirmed": true,
  "expert_on_call": true,
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "language": "string",
  "last_used_at": "2019-08-24T14:15:22Z",
  "license": "string",
  "location": "string",
  "name": "string",
  "oauth2": {
    "account_url": "string",
    "logout_url": "string",
    "provider": "string"
  },
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "phone": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "title": "string",
  "token_permissions": [
    "string"
  ],
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether or not user account is active and able to make calls
admin_pods [object] false none none
» id integer false none Identifier of the pod
» name string false none Name of the pod
auth_type string false none How this user authenticates
available boolean false none Available status of user (ONLINE, BUSY, IDLE).
avatar avatarV1 false none User's avatar URL
created_at string(date-time) false none none
email string false none Email of user
email_confirmed boolean false none Whether or not the accounts requested email is confirmed
expert_on_call boolean false none Whether or not the user is on call
id integer(int32) false none User identifier
is_confirmed boolean false none Whether or not the user account is confirmed for login
is_first_login boolean false none Whether or not the user has logged in for the first time
language string false none User's preferred language
last_used_at string(date-time) false none Last time this user account was used in the app
license string false none License of the user (team or expert)
location string false none Location of the user
name string false none Display name of user
oauth2 object false none none
» account_url string false none URL for modifying oauth2 provider account
» logout_url string false none URL for logging out of oauth2 provider
» provider string false none name of oauth2 provider
permissions [string] false none List of permissions for this user account
personal_room_session_id string false none The user's personal meeting room session id if they have one. An empty string if they don't.
personal_room_url string false none The user's personal meeting room url if they have one. An empty string if they don't.
phone string false none Phone number of user
role_id integer false none The user's role ID
role_name string false none The user's role
status string false none Status of the user (Registered, Invited)
status_message string false none Status message of contact
title string false none Title of the user
token_permissions [string] false none Fine-grained list of permissions for this user account that are returned on login
unavailable_expires_at string(date-time) false none When the unavailable status expires, as a timestamp
updated_at string(date-time) false none none
username string false none Username of user

personas

{
  "entries": [
    {
      "avatar": "string",
      "color": "string",
      "description": "string",
      "id": 0,
      "name": "string",
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [persona] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

planV1

{
  "color": "string",
  "cost_per_user": 0.1,
  "description": "string",
  "featured": "string",
  "id": 0,
  "long_name": "string",
  "max_minutes": 0,
  "max_users": 0,
  "name": "string",
  "plan_type": "string",
  "price": 0.1
}

Properties

Name Type Required Restrictions Description
color string false none Color association with the plan (hex string)
cost_per_user number(float) false none Unit cost per user
description string false none Description of the plan
featured string false none Featured
id integer(int32) false none Plan identifier
long_name string false none Long name of the plan
max_minutes integer(int32) false none Maximum minutes in the plan
max_users integer(int32) false none Maximum users for the plan
name string false none Name of the plan
plan_type string false none Plan type
price number(float) false none Price

podV1

{
  "avatar": "string",
  "capacity": 0,
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "user_count": 0
}

Properties

Name Type Required Restrictions Description
avatar string false none Pod's Avatar URL for dashboard.
capacity integer(int32) false none User capacity of the pod
default boolean false none Denotes default pod
description string false none Description of the pod
enterprise_id integer(int32) false none Enterprise Identifier of the pod
id integer(int32) false none Identifier of the pod
name string false none Name of the pod
user_count integer(int32) false none Number of users in the pod

podV1R1

{
  "admin_count": 0,
  "admins": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string"
    }
  ],
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "default": true,
  "description": "string",
  "enterprise_id": 0,
  "id": 0,
  "name": "string",
  "subpods": [
    {
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ],
  "user_count": 0,
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "manage": true,
      "name": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
admin_count integer(int32) false none Number of admins in the pod
admins [pod_admin] false none none
avatar avatarV1 false none Pod's Avatar URL for dashboard.
default boolean false none Denotes default pod
description string false none Description of the pod
enterprise_id integer(int32) false none Enterprise Identifier of the pod
id integer(int32) false none Identifier of the pod
name string false none Name of the pod
subpods [pod_subpod] false none none
user_count integer(int32) false none Number of users in the pod
users [pod_user] false none none

pod_admin

{
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
avatar avatarV1 false none User's avatar URL
id integer(int32) false none User identifier
name string false none Display name of user

pod_subpod

{
  "id": 0,
  "manage": true,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none Identifier of the pod
manage boolean false none Whether or not this subpod can be managed
name string false none Name of the pod

pod_user

{
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "id": 0,
  "manage": true,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
avatar avatarV1 false none User's avatar URL
id integer(int32) false none User identifier
manage boolean false none Whether or not this user can be managed
name string false none Display name of user

pod_user_option

{
  "active": true,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "email": "string",
  "id": 0,
  "included_in_pod": true,
  "license": "string",
  "location": "string",
  "name": "string",
  "title": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether the user account is active or not
avatar avatarV1 false none User's avatar URL
email string false none Email of the user
id integer(int32) false none User identifier
included_in_pod boolean false none Whether or not the user is already a member of the pod
license string false none License of the user (team or expert)
location string false none Location of the user
name string false none Display name of user
title string false none Title of the user

pod_user_options

{
  "entries": [
    {
      "active": true,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "email": "string",
      "id": 0,
      "included_in_pod": true,
      "license": "string",
      "location": "string",
      "name": "string",
      "title": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [pod_user_option] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

pods

{
  "entries": [
    {
      "avatar": "string",
      "capacity": 0,
      "default": true,
      "description": "string",
      "enterprise_id": 0,
      "id": 0,
      "name": "string",
      "user_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [podV1] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

recent_call

{
  "contact": {
    "active": true,
    "anonymous": true,
    "available": true,
    "avatar": {
      "timestamp": "2019-08-24T14:15:22Z",
      "url": "string"
    },
    "email": "string",
    "enterprise_ids": [
      0
    ],
    "favorite": true,
    "id": "string",
    "is_group": true,
    "name": "string",
    "status": "string",
    "tags": [
      "string"
    ],
    "token": "string",
    "username": "string"
  },
  "contact_name": "string",
  "duration": 0,
  "has_attachments": true,
  "is_group": true,
  "outgoing": true,
  "participants": [
    {
      "email": "string",
      "enterpriseId": 0,
      "id": "string",
      "isAnonymous": true,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    }
  ],
  "ratings": [
    {
      "participant_id": "string",
      "rating": "string"
    }
  ],
  "reason": "string",
  "start_time": "2019-08-24T14:15:22Z",
  "status": true,
  "tags": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
contact call_contact false none none
contact_name string false none none
duration integer(int32) false none none
has_attachments boolean false none none
is_group boolean false none Whether or not this was an expert group call
outgoing boolean false none none
participants [participant] false none List of participants in this call
ratings [call_ratings] false none List of ratings
reason string false none none
start_time string(date-time) false none none
status boolean false none none
tags [string] false none List of tags

refresh_tokenV1

{
  "refresh": "string",
  "token": "string"
}

Properties

Name Type Required Restrictions Description
refresh string false none Refresh token of user
token string false none Token used for authentication.

register_confirm

{
  "message": "string",
  "status": "string"
}

Properties

Name Type Required Restrictions Description
message string false none none
status string false none none

registration_status

{
  "status": "string"
}

Properties

Name Type Required Restrictions Description
status string false none the status of appliance registration

report_status

{
  "inserted_at": "2019-08-24T14:15:22Z",
  "status": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "url": "string",
  "uuid": "string"
}

Properties

Name Type Required Restrictions Description
inserted_at string(date-time) false none none
status string false none The current status which can be pending, complete, or failed
updated_at string(date-time) false none none
url string false none The URL to the completed report.
uuid string false none The uuid of this report

report_statuses

[
  {
    "inserted_at": "2019-08-24T14:15:22Z",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "url": "string",
    "uuid": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [report_status] false none none

report_uuid

{
  "uuid": "string"
}

Properties

Name Type Required Restrictions Description
uuid string false none UUID of job which can be used to query the status

role

{
  "default_role": true,
  "hr_name": "string",
  "name": "string",
  "permissions": [
    {
      "description": "string",
      "hr_name": "string",
      "name": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
default_role boolean false none Whether or not the role is available to all enterprises.
hr_name string false none Human readable role name
name string false none Internal role name
permissions [object] false none List of permissions for the role
» description string false none none
» hr_name string false none none
» name string false none none

roles

{
  "entries": [
    {
      "default_role": true,
      "hr_name": "string",
      "name": "string",
      "permissions": [
        {
          "description": "string",
          "hr_name": "string",
          "name": "string"
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [role] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

search_result

{
  "active": true,
  "avatar": [
    "string"
  ],
  "id": 0,
  "name": "string",
  "token": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether or not user is active
avatar [string] false none Avatar URL of user
id integer(int32) false none Unique identifier for the user
name string false none Name of user
token string false none A public user token
username string false none Username of user

sessionV1

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "name": "string",
      "status": 0,
      "token": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Properties

Name Type Required Restrictions Description
id string false none Session ID
pin string false none A PIN that guests can use to enter the session
token string false none A Session Token
updated_at string false none A date string when this was last updated
users [object] false none none
» avatar avatarV1 false none none
» id integer false none User's ID
» name string false none User's display name
» status integer false none Users status
» token string false none User's public token
» username string false none User's username
video_active boolean false none Whether users are actively in the video session

sessionV1R1

{
  "id": "string",
  "pin": "string",
  "token": "string",
  "updated_at": "string",
  "users": [
    {
      "active": true,
      "enterprise_id": 0,
      "id": "string",
      "name": "string",
      "username": "string"
    }
  ],
  "video_active": true
}

Properties

Name Type Required Restrictions Description
id string false none none
pin string false none none
token string false none none
updated_at string false none none
users [object] false none none
» active boolean false none none
» enterprise_id integer false none none
» id string false none none
» name string false none none
» username string false none none
video_active boolean false none none

session_authV1

{
  "gss_info": {
    "server": "string",
    "token": "string",
    "wsserver": "string"
  }
}

Properties

Name Type Required Restrictions Description
gss_info object false none none
» server string false none The Gss server URL to connect to
» token string false none A Session token for use with Gss
» wsserver string false none The Gss websocket server URL to connect to

session_call

{
  "call_id": "string",
  "complete": true,
  "dialer": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "duration": 0,
  "end_time": "2019-08-24T14:15:22Z",
  "receiver": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "recording_status": "string",
  "recording_url": "string",
  "session_id": "string",
  "start_time": "2019-08-24T14:15:22Z",
  "successful": true
}

Properties

Name Type Required Restrictions Description
call_id string false none Call ID
complete boolean false none Whether the call is in progress or completed
dialer session_call_user false none none
duration integer false none The length of the call in seconds
end_time string(date-time) false none The end time of the call
receiver session_call_user false none none
recording_status string false none The status of the recording
recording_url string false none The URL to the recording
session_id string false none Session ID
start_time string(date-time) false none The start time of the call
successful boolean false none If the call was successful

session_call_user

{
  "email": "string",
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
email string false none The user's email
id string false none The user's id
name string false none The user's name

session_calls

[
  {
    "call_id": "string",
    "complete": true,
    "dialer": {
      "email": "string",
      "id": "string",
      "name": "string"
    },
    "duration": 0,
    "end_time": "2019-08-24T14:15:22Z",
    "receiver": {
      "email": "string",
      "id": "string",
      "name": "string"
    },
    "recording_status": "string",
    "recording_url": "string",
    "session_id": "string",
    "start_time": "2019-08-24T14:15:22Z",
    "successful": true
  }
]

Properties

Name Type Required Restrictions Description
anonymous [session_call] false none none

session_request_auth

{
  "request_id": "string",
  "request_ids": [
    "string"
  ],
  "session_auth": {
    "gss_info": {
      "server": "string",
      "token": "string",
      "wsserver": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
request_id string false none The request Id. This is deprecated, as there can be multiple request_ids. Use request_ids list instead.
request_ids [string] false none The list of request ids. If there are multiple users in this session, we ring each of them, each with a different request ids.
session_auth session_authV1 false none none

sessions

{
  "entries": [
    {
      "id": "string",
      "pin": "string",
      "token": "string",
      "updated_at": "string",
      "users": [
        {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "name": "string",
          "status": 0,
          "token": "string",
          "username": "string"
        }
      ],
      "video_active": true
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [sessionV1] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

subscriptionV1

{
  "active": true,
  "billing_day": 0,
  "canceled_at": "string",
  "card_last4": "string",
  "card_type": "string",
  "delinquent": true,
  "delinquent_at": "string",
  "id": 0,
  "mobile_users": 0,
  "monthly_base_cost": 0.1,
  "subscription_end": "string",
  "trial_end": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether or not the enterprise is active
billing_day integer(int32) false none Recurring billing day of the month
canceled_at string false none Cancellation date
card_last4 string false none Last 4 digits of credit card
card_type string false none Type of credit card
delinquent boolean false none Whether or not subscription is deliquent
delinquent_at string false none When the subscription becomes deliquent
id integer(int32) false none Subscription identifier
mobile_users integer(int32) false none Number of users in the account
monthly_base_cost number(float) false none Monthly subscription cost
subscription_end string false none Subscription end date
trial_end string false none Trial period end date

success

{
  "message": "string",
  "status": true
}

Properties

Name Type Required Restrictions Description
message string false none Description of what was done
status boolean false none True if the operation was successful

tokenV1

{
  "token": "string"
}

Properties

Name Type Required Restrictions Description
token string false none Token used for authentication.

token_info

{
  "created_at": 0,
  "data": "string",
  "expires_at": 0,
  "issuer": "string",
  "permissions": [
    "string"
  ],
  "status": "string"
}

Properties

Name Type Required Restrictions Description
created_at integer false none JWT created at time, as a unix timestamp
data string false none The "sub" claims of the JWT
expires_at integer false none JWT expiration time, as a unix timestamp
issuer string false none JWT issuer
permissions [string] false none List of permissions available for this token
status string false none Whether or not the token is valid

user

{
  "active": true,
  "available": "string",
  "avatar": "string",
  "confirmed_email": true,
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "id": 0,
  "is_confirmed": true,
  "is_first_login": true,
  "last_used_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": [
    "string"
  ],
  "personal_room_session_id": "string",
  "personal_room_url": "string",
  "role_id": 0,
  "role_name": "string",
  "status": "string",
  "status_message": "string",
  "token": "string",
  "unavailable_expires_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether or not user account is active and able to make calls
available string false none Available status of user (ONLINE, BUSY, IDLE).
avatar string false none User's avatar URL
confirmed_email boolean false none Whether or not the accounts requested email is confirmed
created_at string(date-time) false none none
email string false none Email of user
id integer(int32) false none User identifier
is_confirmed boolean false none Whether or not the user account is confirmed for login
is_first_login boolean false none Whether or not the user has logged in for the first time
last_used_at string(date-time) false none Last time this user account was used in the app
name string false none Display name of user
permissions [string] false none List of permissions for this user account
personal_room_session_id string false none The user's personal meeting room session id if they have one. An empty string if they don't.
personal_room_url string false none The user's personal meeting room url if they have one. An empty string if they don't.
role_id integer false none The user's role ID
role_name string false none The user's role
status string false none Status of the user (Registered, Invited)
status_message string false none Status message of contact
token string false none Token for further actions on the contact.
unavailable_expires_at string(date-time) false none When the unavailable status expires, as a timestamp
updated_at string(date-time) false none none
username string false none Username of user

user_disclaimer

{
  "delete_user_upon_decline": true,
  "disclaimer_text": "string",
  "enterprise_id": "string",
  "enterprise_name": "string",
  "needs_acceptance": true
}

Properties

Name Type Required Restrictions Description
delete_user_upon_decline boolean false none Delete users upon disclaimer
disclaimer_text string false none Text of disclaimer
enterprise_id string false none Enterprise ID that owns the disclaimer
enterprise_name string false none Name of the enterprise that owns the disclaimer
needs_acceptance boolean false none Whether or not you need to accept the disclaimer

user_workspace

{
  "id": 0,
  "name": "string",
  "workspace_id": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none The user alias ID
name string false none The name of workspaces
workspace_id integer(int32) false none The workspace ID

users

{
  "entries": [
    {
      "active": true,
      "available": "string",
      "avatar": "string",
      "confirmed_email": true,
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "id": 0,
      "is_confirmed": true,
      "is_first_login": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "permissions": [
        "string"
      ],
      "personal_room_session_id": "string",
      "personal_room_url": "string",
      "role_id": 0,
      "role_name": "string",
      "status": "string",
      "status_message": "string",
      "token": "string",
      "unavailable_expires_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "username": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [user] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

validated_token_info

{
  "created_at": 0,
  "data": "string",
  "expires_at": 0,
  "id": "string",
  "issuer": "string",
  "permissions": [
    "string"
  ],
  "status": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
created_at integer false none JWT created at time, as a unix timestamp
data string false none The "sub" claims of the JWT
expires_at integer false none JWT expiration time, as a unix timestamp
id string false none Identifier for the resource the token represents
issuer string false none JWT issuer
permissions [string] false none List of permissions available for this token
status string false none Whether or not the token is valid
type string false none What type of resource the token represents

workbox

{
  "assigned_at": "string",
  "closed_at": "string",
  "created_by": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "description": "string",
  "fields": [
    {}
  ],
  "guests": [
    {
      "has_joined": true,
      "id": 0,
      "last_read_message_id": 0,
      "name": "string",
      "unread_count": 0,
      "uuid": "string"
    }
  ],
  "queues": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "assigned_to": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "inserted_at": "string",
  "last_active_at": "string",
  "last_read_message_id": 0,
  "participants": [
    {
      "accepted_at": "string",
      "assigned": true,
      "creator": true,
      "has_participated": true,
      "id": 0,
      "important": true,
      "name": "string",
      "removed": true
    }
  ],
  "procedureCount": 0,
  "procedures": [
    {}
  ],
  "reported_at": "string",
  "status": "string",
  "ticketFieldsFull": [
    {}
  ],
  "token": "string",
  "unread_messages_count": 0,
  "updated_at": "string",
  "version": "string"
}

Properties

Name Type Required Restrictions Description
assigned_at string false none none
closed_at string false none none
created_by brief_contact false none User details for who initially created the workbox
description string false none none
fields [object] false none workbox custom fields
guests [workbox_guest] false none none
queues [object] false none none
» id integer(int32) false none none
» name string false none none
assigned_to object false none none
» id integer(int32) false none none
» name string false none none
id integer(int32) false none The unique workbox ID
inserted_at string false none none
last_active_at string false none none
last_read_message_id integer(int32) false none none
participants [workbox_participant] false none none
procedureCount number false none workbox procedures which does not deleted
procedures [object] false none workbox procedures
reported_at string false none none
status string false none Status of the workbox, may be REPORTED, ASSIGNED or CLOSED
ticketFieldsFull [object] false none workspace custom fields
token string false none A JWT used to manipulate the workbox
unread_messages_count integer(int32) false none none
updated_at string false none none
version string false none The version of the workbox

workbox_guest

{
  "has_joined": true,
  "id": 0,
  "last_read_message_id": 0,
  "name": "string",
  "unread_count": 0,
  "uuid": "string"
}

Properties

Name Type Required Restrictions Description
has_joined boolean false none none
id integer(int32) false none none
last_read_message_id integer(int32) false none none
name string false none none
unread_count integer(int32) false none none
uuid string false none none

workbox_info

{
  "auto_created": true,
  "owner_id": 0,
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  }
}

Properties

Name Type Required Restrictions Description
auto_created boolean false none Whether the workbox was auto generated by the server as a result of a call
owner_id integer(int32) false none The owner ID of the workbox
workbox workbox false none The workbox structure

workbox_message

{
  "deleted": true,
  "deleted_at": "string",
  "edited": true,
  "edited_at": "string",
  "id": 0,
  "internal": true,
  "metadata": "string",
  "read": true,
  "sent_at": "string",
  "type": "string",
  "user": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "user_name": "string",
  "uuid": "string",
  "version": 0,
  "workbox_id": 0
}

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deleted_at string false none none
edited boolean false none none
edited_at string false none none
id integer false none ID of the message in the workbox
internal boolean false none Whether or not this is an internal message
metadata string false none JSON data for the message, includes the message content
read boolean false none Whether or not the message has been read by you
sent_at string false none none
type string false none Type of the message
user brief_contact false none User information about who sent the message
user_name string false none Human readable name of the user who sent the message
uuid string false none none
version integer false none none
workbox_id integer false none ID of the workbox

workbox_messageV1R2

{
  "deleted": true,
  "deleted_at": "string",
  "edited": true,
  "edited_at": "string",
  "id": 0,
  "internal": true,
  "metadata": "string",
  "read": true,
  "sent_at": "string",
  "type": "string",
  "user": {
    "avatar": {
      "full": "string",
      "thumb": "string"
    },
    "id": 0,
    "location": "string",
    "name": "string",
    "title": "string",
    "username": "string"
  },
  "user_name": "string",
  "uuid": "string",
  "version": 0,
  "workbox_id": 0,
  "root_id": -1,
  "root_message": {
    "deleted": true,
    "deleted_at": "string",
    "edited": true,
    "edited_at": "string",
    "id": 0,
    "internal": true,
    "metadata": "string",
    "read": true,
    "sent_at": "string",
    "type": "string",
    "user": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "user_name": "string",
    "uuid": "string",
    "version": 0,
    "workbox_id": 0
  },
  "parent_id": -1,
  "reply_count": 0
}

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deleted_at string false none none
edited boolean false none none
edited_at string false none none
id integer false none ID of the message in the workbox
internal boolean false none Whether or not this is an internal message
metadata string false none JSON data for the message, includes the message content
read boolean false none Whether or not the message has been read by you
sent_at string false none none
type string false none Type of the message
user brief_contact false none User information about who sent the message
user_name string false none Human readable name of the user who sent the message
uuid string false none none
version integer false none none
workbox_id integer false none ID of the workbox
root_id integer false none ID of the root message
root_message workbox_message false none the root message
parent_id integer false none ID of the parent message
reply_count integer false none root message reply count

workbox_participant

{
  "accepted_at": "string",
  "assigned": true,
  "creator": true,
  "has_participated": true,
  "id": 0,
  "important": true,
  "name": "string",
  "removed": true
}

Properties

Name Type Required Restrictions Description
accepted_at string false none none
assigned boolean false none Whether or not the associated workbox is assigned to this participant
creator boolean false none Whether or not this user is the initial creator of the workbox
has_participated boolean false none none
id integer(int32) false none ID of the participant in the session (NOT the user id)
important boolean false none Whether or not the user marked the associated workbox as important
name string false none none
removed boolean false none Whether or not this user was removed from the workbox

workbox_message_participant_receipt_status

{
  "user_id": 0,
  "received": true,
  "read": true
}

Properties

Name Type Required Restrictions Description
user_id integer(int32) false none none
received boolean false none Whether or not this message is received by the participant
read boolean false none Whether or not this message is read by the participant

workbox_receipt_status

{
  "most_recent_partial_received": 0,
  "most_recent_all_received": 0,
  "most_recent_partial_read": 0,
  "most_recent_all_read": 0
}

Properties

Name Type Required Restrictions Description
most_recent_partial_received integer(int32) false none none
most_recent_all_received integer(int32) false none none
most_recent_partial_read integer(int32) false none none
most_recent_all_read integer(int32) false none none

workboxes_info

{
  "closed": 0,
  "last_active_at": "string",
  "open": 0,
  "total": 0,
  "unread_count_closed": 0,
  "unread_count_open": 0,
  "unread_count_total": 0
}

Properties

Name Type Required Restrictions Description
closed integer(int32) false none The total count of closed workboxes
last_active_at string false none Timestamp of the last active workbox, or null if none exist.
open integer(int32) false none The total count of open workboxes
total integer(int32) false none The total count of workboxes, including open and closed
unread_count_closed integer(int32) false none The unread message count across closed workboxes
unread_count_open integer(int32) false none The unread message count across open workboxes
unread_count_total integer(int32) false none The total unread message count across all workboxes

workspace_user_option

{
  "active": true,
  "alias_user_id": 0,
  "avatar": {
    "full": "string",
    "thumb": "string"
  },
  "email": "string",
  "id": 0,
  "included_in_workspace": true,
  "location": "string",
  "name": "string",
  "title": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Whether the user account is active or not
alias_user_id integer false none Alias User identifier
avatar avatarV1 false none User's avatar URL
email string false none Email of the user
id integer(int32) false none User identifier
included_in_workspace boolean false none Whether or not the user is already a member of the workspace
location string false none Location of the user
name string false none Display name of user
title string false none Title of the user

workspace_user_options

{
  "entries": [
    {
      "active": true,
      "alias_user_id": 0,
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "email": "string",
      "id": 0,
      "included_in_workspace": true,
      "location": "string",
      "name": "string",
      "title": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_entries": 0,
  "total_pages": 0
}

Properties

Name Type Required Restrictions Description
entries [workspace_user_option] false none none
page integer(int32) false none none
page_size integer(int32) false none none
total_entries integer(int32) false none none
total_pages integer(int32) false none none

asset

{
  "id": 0,
  "enterprise_id": 0,
  "area_id": 0,
  "uuid": "string",
  "name": "string",
  "description": "string",
  "serial_number": "string",
  "model_number": "string",
  "error_message": "string",
  "error": true,
  "latitude": 0.1,
  "longitude": 0.1,
  "last_update": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none Asset ID
enterprise_id integer(int32) false none ID of the enterprise that owns the Asset
area_id integer(int32) false none ID of the parent Area
uuid string false none Unique ID
name string false none Name of the asset
description string false none Description of the asset
serial_number string false none Serial number of the asset
model_number string false none Model number of the asset
error_message string false none Error message of the asset
error boolean false none Whether or not this asset has an error
latitude number(float) false none That latitude of the position of the asset
longitude number(float) false none That longitude of the position of the asset
last_update string(date-time) false none The last time a meaningful change occurred on this asset
updated_at string(date-time) false none none
inserted_at string(date-time) false none none
deleted_at string(date-time) false none none
deleted boolean false none Whether or not this asset has been deleted

area

{
  "id": 0,
  "name": "string",
  "enterprise_id": 0,
  "uuid": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "updated_at": "2019-08-24T14:15:22Z",
  "inserted_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "deleted": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none Area identifier
name string false none Name of the Area
enterprise_id integer(int32) false none ID of the owner enterprise of this Area
uuid string false none Unique ID of the Area
latitude number(float) false none That latitude of the position of the area
longitude number(float) false none That longitude of the position of the area
updated_at string(date-time) false none none
inserted_at string(date-time) false none none
deleted_at string(date-time) false none none
deleted boolean false none Whether or not this area has been deleted

areas_page

{
  "entries": [
    {
      "id": 0,
      "name": "string",
      "enterprise_id": 0,
      "uuid": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "updated_at": "2019-08-24T14:15:22Z",
      "inserted_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "deleted": true
    }
  ],
  "after": "string"
}

Properties

Name Type Required Restrictions Description
entries [area] false none List of areas
after string false none Cursor to the next page of results, or null if end of entries

assets_page

{
  "entries": [
    {
      "id": 0,
      "enterprise_id": 0,
      "area_id": 0,
      "uuid": "string",
      "name": "string",
      "description": "string",
      "serial_number": "string",
      "model_number": "string",
      "error_message": "string",
      "error": true,
      "latitude": 0.1,
      "longitude": 0.1,
      "last_update": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "inserted_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "deleted": true
    }
  ],
  "after": "string"
}

Properties

Name Type Required Restrictions Description
entries [asset] false none List of assets
after string false none Cursor to the next page of results, or null if end of entries

user_queue

{
  "id": "string",
  "enterprise_id": "string",
  "name": "string",
  "description": "string",
  "unassigned_workboxes_count": 0,
  "open_workboxes_count": 0,
  "updated_at": "string",
  "inserted_at": "string"
}

Properties

Name Type Required Restrictions Description
id string false none Queue ID
enterprise_id string false none Enterprise ID
name string false none Queue name
description string false none Queue description
unassigned_workboxes_count integer false none Number of unassigned workboxes in the queue
open_workboxes_count integer false none Number of open workboxes in the queue
updated_at string false none A date string when this was last updated
inserted_at string false none A date string when this was created

user_queue_page

{
  "entries": [
    {
      "id": "string",
      "enterprise_id": "string",
      "name": "string",
      "description": "string",
      "unassigned_workboxes_count": 0,
      "open_workboxes_count": 0,
      "updated_at": "string",
      "inserted_at": "string"
    }
  ],
  "after": "string",
  "total": 0
}

Properties

Name Type Required Restrictions Description
entries [user_queue] false none List of queues
after string false none Cursor to the next page of results, or null if end of entries
total integer false none The total number of queues visible to the user

enterprise_queue_page

{
  "entries": [
    {
      "id": "string",
      "enterprise_id": "string",
      "name": "string",
      "description": "string",
      "updated_at": "string",
      "inserted_at": "string",
      "notify_users_via_realtime": true,
      "notify_users_via_email": true,
      "notify_admins_via_email": true,
      "notify_admins_via_realtime": true
    }
  ],
  "after": "string",
  "total": 0
}

Properties

Name Type Required Restrictions Description
entries [enterprise_queue_brief] false none List of queues
after string false none Cursor to the next page of results, or null if end of entries
total integer false none The total number of queues in the enterprise

queued_workbox

{
  "priority": "string",
  "assigned": true,
  "assigned_to": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "workbox": {
    "assigned_at": "string",
    "closed_at": "string",
    "created_by": {
      "avatar": {
        "full": "string",
        "thumb": "string"
      },
      "id": 0,
      "location": "string",
      "name": "string",
      "title": "string",
      "username": "string"
    },
    "description": "string",
    "fields": [
      {}
    ],
    "guests": [
      {
        "has_joined": true,
        "id": 0,
        "last_read_message_id": 0,
        "name": "string",
        "unread_count": 0,
        "uuid": "string"
      }
    ],
    "queues": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assigned_to": {
      "id": 0,
      "name": "string"
    },
    "id": 0,
    "inserted_at": "string",
    "last_active_at": "string",
    "last_read_message_id": 0,
    "participants": [
      {
        "accepted_at": "string",
        "assigned": true,
        "creator": true,
        "has_participated": true,
        "id": 0,
        "important": true,
        "name": "string",
        "removed": true
      }
    ],
    "procedureCount": 0,
    "procedures": [
      {}
    ],
    "reported_at": "string",
    "status": "string",
    "ticketFieldsFull": [
      {}
    ],
    "token": "string",
    "unread_messages_count": 0,
    "updated_at": "string",
    "version": "string"
  },
  "queue_id": 0
}

Properties

Name Type Required Restrictions Description
priority string false none The priority of workbox
assigned boolean false none The workbox was assigned
assigned_to string false none The user that the workbox was assigned to
updated_at string false none A date string when this was last updated
inserted_at string false none A date string when this was created
workbox workbox false none The workbox structure
queue_id integer false none The ID of the queue this workbox is in

queued_workbox_page

{
  "entries": [
    {
      "priority": "string",
      "assigned": true,
      "assigned_to": "string",
      "updated_at": "string",
      "inserted_at": "string",
      "workbox": {
        "assigned_at": "string",
        "closed_at": "string",
        "created_by": {
          "avatar": {
            "full": "string",
            "thumb": "string"
          },
          "id": 0,
          "location": "string",
          "name": "string",
          "title": "string",
          "username": "string"
        },
        "description": "string",
        "fields": [
          {}
        ],
        "guests": [
          {
            "has_joined": true,
            "id": 0,
            "last_read_message_id": 0,
            "name": "string",
            "unread_count": 0,
            "uuid": "string"
          }
        ],
        "queues": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "assigned_to": {
          "id": 0,
          "name": "string"
        },
        "id": 0,
        "inserted_at": "string",
        "last_active_at": "string",
        "last_read_message_id": 0,
        "participants": [
          {
            "accepted_at": "string",
            "assigned": true,
            "creator": true,
            "has_participated": true,
            "id": 0,
            "important": true,
            "name": "string",
            "removed": true
          }
        ],
        "procedureCount": 0,
        "procedures": [
          {}
        ],
        "reported_at": "string",
        "status": "string",
        "ticketFieldsFull": [
          {}
        ],
        "token": "string",
        "unread_messages_count": 0,
        "updated_at": "string",
        "version": "string"
      },
      "queue_id": 0
    }
  ],
  "after": "string",
  "total": 0
}

Properties

Name Type Required Restrictions Description
entries [queued_workbox] false none List of assets
after string false none Cursor to the next page of results, or null if end of entries
total integer false none The total number of queues visible to the use

queue_email

{
  "id": 0,
  "email": "string",
  "validated": true,
  "updated_at": "string",
  "inserted_at": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none The ID of the email notification
email string false none The email address to use
validated boolean false none Whether or not the email has been validated
updated_at string false none A date string when this was last updated
inserted_at string false none A date string when this was created

expert

{
  "id": 0,
  "name": "string",
  "email": "string",
  "title": "string",
  "location": "string",
  "avatar": {
    "full": "string",
    "thumb": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer false none none
name string false none none
email string false none none
title string false none none
location string false none none
avatar avatarV1 false none none

experts_page

{
  "entries": [
    {
      "id": 0,
      "name": "string",
      "email": "string",
      "title": "string",
      "location": "string",
      "avatar": {
        "full": "string",
        "thumb": "string"
      }
    }
  ],
  "after": "string",
  "total": 0
}

Properties

Name Type Required Restrictions Description
entries [expert] false none List of experts
after string false none Cursor to the next page of results, or null if end of entries
total integer false none The total number of experts

enterprise_queue

{
  "id": "string",
  "enterprise_id": "string",
  "name": "string",
  "description": "string",
  "unassigned_workboxes_count": 0,
  "open_workboxes_count": 0,
  "updated_at": "string",
  "inserted_at": "string",
  "pod_ids": [
    "string"
  ],
  "notify_users_via_realtime": true,
  "notify_users_via_email": true,
  "notify_admins_via_email": true,
  "notify_admins_via_realtime": true
}

Properties

Name Type Required Restrictions Description
id string false none Queue ID
enterprise_id string false none Enterprise ID
name string false none User Queue name
description string false none User Queue description
unassigned_workboxes_count integer false none Number of unassigned workboxes in the queue
open_workboxes_count integer false none Number of open workboxes in the queue
updated_at string false none A date string when this was last updated
inserted_at string false none A date string when this was created
pod_ids [string] false none List of pod IDs that are in this queue
notify_users_via_realtime boolean false none Whether or not to notify users via realtime
notify_users_via_email boolean false none Whether or not to notify users via email
notify_admins_via_email boolean false none Whether or not to notify admins via email
notify_admins_via_realtime boolean false none Whether or not to notify admins via realtime

enterprise_queue_brief

{
  "id": "string",
  "enterprise_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "inserted_at": "string",
  "notify_users_via_realtime": true,
  "notify_users_via_email": true,
  "notify_admins_via_email": true,
  "notify_admins_via_realtime": true
}

Properties

Name Type Required Restrictions Description
id string false none Queue ID
enterprise_id string false none Enterprise ID
name string false none User Queue name
description string false none User Queue description
updated_at string false none A date string when this was last updated
inserted_at string false none A date string when this was created
notify_users_via_realtime boolean false none Whether or not to notify users via realtime
notify_users_via_email boolean false none Whether or not to notify users via email
notify_admins_via_email boolean false none Whether or not to notify admins via email
notify_admins_via_realtime boolean false none Whether or not to notify admins via realtime
Shell HTTP JavaScript Ruby Python PHP Java Go