ClientListAssociates

GET - /v3/reseller/client/list-associates

Required Permissions:

scope:reseller

Description

Lists all associate clients under the specified client.

Headers

Header Key	Description	Example
Authorization	The Authorization header for this endpoint. The value must be the token from the /v3/auth/tokens/get endpoint and given using the Bearer pattern.	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW...

Query Parameters

Name	Type	Description
parentId	string	The ID of the parent client to query. If omitted, uses the client associated with the caller's API key.

Successful Response

A successful response

Field Name	Type	Description
associates	array<object>	The list of IDs for the associate clients under this client, if applicable.
id	uuid	The ID for the client
name	string	The name of the client
isReseller	boolean	Whether the client is a reseller
contact	object
dateCreated	date-time	The ISO-8601 timestamp of when the client was created

Code Example

cURL

curl \
  -X GET "https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

JavaScript (Fetch)

function getV3ResellerClientListAssociates() {

  const url = 'https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123';
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  fetch(url, {
    method: 'GET',
    headers: headers
  }).then((response) => {
    if (!response.ok) throw new Error(response.status);
    return response.json()
  }).then((json) => {
    const { associates, id, name, isReseller, contact, dateCreated } = json;
    // ...
  });
}

JavaScript (Node)

const https = require('https');

function getV3ResellerClientListAssociates() {

  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: '/v3/reseller/client/list-associates',
    method: 'GET',
    qs: { parentId: 'abc123' },
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { associates, id, name, isReseller, contact, dateCreated } = JSON.parse(d);
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.end();
  
}

JavaScript (Axios)

const axios = require('axios').default;

async function getV3ResellerClientListAssociates() {

  const url = 'https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123';
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const response = await axios.get(url, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { associates, id, name, isReseller, contact, dateCreated } = response.data;
  
  // ...
}

TypeScript (Node)

import * as https from 'https';

function getV3ResellerClientListAssociates(): void {

  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: '/v3/reseller/client/list-associates',
    method: 'GET',
    qs: { parentId: 'abc123' },
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { associates, id, name, isReseller, contact, dateCreated } = JSON.parse(d) as Record<string, unknown>;
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.end();
}

TypeScript (Axios)

import axios from 'axios';

async function getV3ResellerClientListAssociates(): Promise<void> {

  const url = 'https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123';
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const response = await axios.get(url, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { associates, id, name, isReseller, contact, dateCreated } = response.data;
  // ...
}

Python (Requests)

import requests

def get_v3_reseller_client_list_associates():
    url = 'https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates'
    
    headers = {
        'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
    }
    
    response = requests.get(
        url,
        params={
            'parentId': 'abc123'
        },
        headers=headers,
    )
    
    if response.status_code !== 200:
        raise Exception(response.status_code)
    
    response_obj = response.json()
    associates = response_obj['associates']
    id = response_obj['id']
    name = response_obj['name']
    is_reseller = response_obj['isReseller']
    contact = response_obj['contact']
    date_created = response_obj['dateCreated']
    
    # ...

Java

import org.json.simple.JSONObject;
import org.json.simple.JSONArray;
import org.json.simple.JSONParser;
import org.json.simple.JSONValue;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;

public class CanarySpeechApi {

  public void getV3ResellerClientListAssociates() {
    URI uri = new URI("https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123");
    
    HttpRequest request = HttpRequest.newBuilder()
      .uri(uri)
      .version(HttpClient.Version.HTTP_2)
      .header("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
      .GET()
      .build();
    
    HttpClient client = HttpClient.newBuilder()
      .version(HttpClient.Version.HTTP_1_1)
      .build();
    
    HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
    
    if (client.status != 200) {
      throw new Exception(client.status.toString());
    }
    
    JSONParser parser = new JSONParser();
    JSONObject responseBody = (JSONObject) parser.parse(client.body());
    List<Object> associates = (List<Object>) responseBody.get("associates");
    String id = (String) responseBody.get("id");
    String name = (String) responseBody.get("name");
    Boolean isReseller = (Boolean) responseBody.get("isReseller");
    Map<String, Object> contact = (Map<String, Object>) responseBody.get("contact");
    String dateCreated = (String) responseBody.get("dateCreated");
    
    // ...
  }

}

Kotlin

import org.json.JSONObject
import java.lang.StringBuilder
import java.net.URL
import javax.net.ssl.HttpsURLConnection

suspend fun getV3ResellerClientListAssociates() = runCatching {
    val url = URL.create("https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123")
    with(url.openConnection() as HttpsURLConnection) {
        requestMethod = "GET"
        instanceFollowRedirects = true
        
        setRequestProperty("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
        
        doOutput = true
        
        if (responseCode != 200) throw Error(responseMessage)
        
        val buffer = StringBuilder()
        var line: String?
        inputStream.bufferedReader(Charsets.UTF-8).use {
            do {
                line = it.readLine()
                if (line != null) buffer.appendLine(line)
            } while (line != null)
        }
        
        val responseBody = JSONObject(buffer.toString())
        val associates = responseBody.get("associates") as Array<Object>
        val id = responseBody.get("id") as String
        val name = responseBody.get("name") as String
        val isReseller = responseBody.get("isReseller") as Boolean
        val contact = responseBody.get("contact") as Map<String, Any?>
        val dateCreated = responseBody.get("dateCreated") as String
        
        // ...
    }
}

Swift (URLSession)

import UIKit

func getV3ResellerClientListAssociates() -> void {
    
    let url = URL("https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123")
    
    let headers: [String: String] = [
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
    ]
    
    var request = URLRequest(url: url)
    request.httpMethod = "GET"
    request.allHTTPHeaderFields = headers
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        guard
            let data = data,
            let response = response as? HTTPURLResponse,
            error == nil
        else {
            print("error", error ?? URLError(.badServerResponse)
            return
        }
        
        guard (200 ... 299) ~= response.statusCode else {
            print("statusCode = \(response.statusCode)")
            print("response = \(response)")
            return
        }
        
        do {
            let responseObj = try JSONDecoder().decode(GetV3ResellerClientListAssociatesResponse.self, data)
            // ...
        } catch {
            print(error)
        }
    }
    }
}

struct GetV3ResellerClientListAssociatesResponse: Decodable {
    let associates: [undefined]
    let id: String
    let name: String
    let isReseller: Bool
    let contact: [String: Any]
    let dateCreated: String
}

using System.Collections.Generic;
using System.Net.Http;
using System.Text.Encoding;
using System.Text.Json;
using System.Text.Json.Serialization;

public static class CanarySpeechAPI
{
    public static readonly HttpClient client = new HttpClient();
    
    public static async Task getV3ResellerClientListAssociates()
    {
        var url = "https://rest.eus.canaryspeech.com/v3/reseller/client/list-associates?parentId=abc123\"";
        
        var request = new HttpRequestMessage(HttpMethod.Get, url);
        request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c");
        
        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();
        
        var responseBody = await response.Content.ReadAsStringAsync();
        var responseJson = JsonConvert.DeserializeObject<Dictionary<string, dynamic>>(responseBody);
        var associates = (List<undefined>)responseJson["associates"];
        var id = (String)responseJson["id"];
        var name = (String)responseJson["name"];
        var isReseller = (bool)responseJson["isReseller"];
        var contact = (Dictionary<String, dynamic>)responseJson["contact"];
        var dateCreated = (String)responseJson["dateCreated"];
        // ...
    }
}

Dart/Flutter

import 'dart:convert';

import 'package:http/http.dart' as http;

Future<void> function getV3ResellerClientListAssociates() async {
  final queryParams = { 'parentId': 'abc123' };
  
  final uri = Uri.https('rest.eus.canaryspeech.com', 'v3/reseller/client/list-associates', queryParams);
  
  final headers = {
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  final request = http.Request('GET', uri);
  request.headers.addAll(headers)
  
  final client = http.Client();
  try {
    final responseStream = await client.send(request);
    final statusCode = responseStream.statusCode;
    
    if (statusCode < 200 || statusCode >= 300) {
      throw Error(statusCode.toString());
    }
    
    final responseBytes = await responseStream.stream.toBytes();
    final responseString = utf8.decode(responseBytes);
    final response = json.decode(responseString);
    
    final associates = response['associates'] as List<dynamic>;
    final id = response['id'] as String;
    final name = response['name'] as String;
    final isReseller = response['isReseller'] as bool;
    final contact = response['contact'] as Map<String, dynamic>?;
    final dateCreated = response['dateCreated'] as String;
    
    // ...
  } catch (e) {
    print(e);
  }
}

Models

contact

Name	Type	Description
email	string	The email of the client
phoneNumber	string	The phone number of the client