Clients
List clients
Retrieve a paginated list of clients with optional filtering.
curl -X GET "https://api.mythic-analytics.com/api/v1/clients?status=true&company_id=example_string&search=example_string&limit=42&offset=42" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.mythic-analytics.com/api/v1/clients?status=true&company_id=example_string&search=example_string&limit=42&offset=42"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.mythic-analytics.com/api/v1/clients?status=true&company_id=example_string&search=example_string&limit=42&offset=42", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
)
func main() {
req, err := http.NewRequest("GET", "https://api.mythic-analytics.com/api/v1/clients?status=true&company_id=example_string&search=example_string&limit=42&offset=42", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.mythic-analytics.com/api/v1/clients?status=true&company_id=example_string&search=example_string&limit=42&offset=42')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"success": true,
"data": [
{
"id": "acme-retail",
"name": "Acme Retail",
"status": true,
"publishable_key": "pk_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"secret_key": "sk_f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3",
"domain": "acme-retail.com",
"email": "ops@acme-retail.com",
"phone": "+1-555-0123",
"website": "example_string",
"timezone": "America/Los_Angeles",
"global_name": "acmeRetail",
"company_id": "cmp_7kH3nPqR",
"agency_id": "example_string",
"api_metadata": {},
"ghl_location_id": "example_string",
"proxy_api_key": "example_string",
"created_at": "2024-03-21T18:42:15.291Z",
"updated_at": "2024-03-21T18:42:15.291Z"
}
],
"count": 2
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
GET
/clients
GET
Security Scheme
Bearer Tokenstring
RequiredAdmin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
Admin API key as bearer token. Format:
Bearer YOUR_ADMIN_KEYquery
statusstring
Filter by active status. Pass true or false.
Options: true, false
query
company_idstring
Filter by company identifier.
query
searchstring
Case-insensitive substring match on client name.
query
limitinteger
Maximum results per page. Default 50, max 500.
Max: 500
query
offsetinteger
Number of results to skip. Default 0.
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
Query Parameters
company_idstring
Filter by company identifier.
searchstring
Case-insensitive substring match on client name.
limitinteger
Maximum results per page. Default 50, max 500.
offsetinteger
Number of results to skip. Default 0.
Responses
successboolean
dataarray
countinteger
Total number of matching resources.
Was this page helpful?
Built with Documentation.AI
Last updated today