List customers - initdesk API

GET

organizations

{organization_id}

customers

List customers

curl --request GET \
  --url https://api.initdesk.com/organizations/{organization_id}/customers/ \
  --header 'X-Initdesk-Token: <api-key>'

import requests

url = "https://api.initdesk.com/organizations/{organization_id}/customers/"

headers = {"X-Initdesk-Token": "<api-key>"}

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

print(response.text)

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

fetch('https://api.initdesk.com/organizations/{organization_id}/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.initdesk.com/organizations/{organization_id}/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 => [
    "X-Initdesk-Token: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.initdesk.com/organizations/{organization_id}/customers/"

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

	req.Header.Add("X-Initdesk-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.initdesk.com/organizations/{organization_id}/customers/")
  .header("X-Initdesk-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.initdesk.com/organizations/{organization_id}/customers/")

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

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

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

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "email": "jsmith@example.com",
      "is_spam": true
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

X-Initdesk-Token

string

header

required

Path Parameters

organization_id

string

required

Query Parameters

ordering

string

Which field to use when ordering the results.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

string

Filter customers by keyword. Matches name and email case-insensitively; accents are ignored (e.g. search Leo matches Léo).

Response

200 - application/json

count

integer

required

Example:

123

results

object[]

required

Show child attributes

string<uri> | null

Example:

"http://api.example.org/accounts/?page=4"

string<uri> | null

Example:

"http://api.example.org/accounts/?page=2"

Create customerCreate a requester (customer) in the organization.

List customers

curl --request GET \
  --url https://api.initdesk.com/organizations/{organization_id}/customers/ \
  --header 'X-Initdesk-Token: <api-key>'

import requests

url = "https://api.initdesk.com/organizations/{organization_id}/customers/"

headers = {"X-Initdesk-Token": "<api-key>"}

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

print(response.text)

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

fetch('https://api.initdesk.com/organizations/{organization_id}/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.initdesk.com/organizations/{organization_id}/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 => [
    "X-Initdesk-Token: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.initdesk.com/organizations/{organization_id}/customers/"

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

	req.Header.Add("X-Initdesk-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.initdesk.com/organizations/{organization_id}/customers/")
  .header("X-Initdesk-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.initdesk.com/organizations/{organization_id}/customers/")

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

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

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

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "email": "jsmith@example.com",
      "is_spam": true
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}