List customers
curl --request GET \
--url https://api.minidesk.ai/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.minidesk.ai/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.minidesk.ai/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.minidesk.ai/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.minidesk.ai/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.minidesk.ai/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.minidesk.ai/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"name": "<string>",
"external_id": "<string>",
"is_verified": true,
"note": "<string>",
"created_at": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}Customers
List customers
The customer directory, most recently active first, cursor paginated. With email, an exact lookup that returns zero or one customer and ignores the other parameters.
GET
/
customers
List customers
curl --request GET \
--url https://api.minidesk.ai/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.minidesk.ai/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.minidesk.ai/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.minidesk.ai/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.minidesk.ai/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.minidesk.ai/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.minidesk.ai/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"name": "<string>",
"external_id": "<string>",
"is_verified": true,
"note": "<string>",
"created_at": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}Authorizations
An API credential from Settings → API, sent as Authorization: Bearer mdsk_api_.... Issued per workspace and shown once.
Query Parameters
The next_cursor from the previous page. Omit for the first page.
Maximum string length:
512Pattern:
^[A-Za-z0-9_-]*$How many customers to return. 1 to 100, default 25.
Required range:
1 <= x <= 100Only the customer with this address, ignoring case.
Maximum string length:
254Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Matches a name or an email address.
Required string length:
1 - 200