Agency API Clients

List all clients

GET https://api.tamio.com/v2/clients/list

Returns a paginated list of clients. Supports filtering by name, country, date range, and associated product. Deleted and pending-deletion clients are automatically excluded.

Query Parameters

page integer*

Page number for pagination (1-based)

per_page integer*

Number of clients per page

order string

Sort order for the results

ascdesc

sort_by string

Field to sort results by

customertotalpaymentdatestatusid

filter string

Search filter to match client names or emails

from string

Start date for filtering clients (ISO 8601 or unix timestamp)

to string

End date for filtering clients (ISO 8601 or unix timestamp)

product_id string

Filter clients by a product they are associated with

countries[] array of string

Filter clients by country codes (pass multiple times for multiple countries)

attributes[] array of string

Additional attributes to include in the response

Responses

200 Clients listed successfully

Clients listed successfully

status integer

total_results integer

Total number of matching clients

clients array of Client

400 Validation or business-logic error. Possible `error_code` values:

401 Unauthorized – invalid or missing Bearer token

Retrieve a client

Delete a client

/clients/list

1 const response = await fetch("https://api.tamio.com/v2/clients/list", {
2   headers: {
3     "Authorization": "Bearer YOUR_API_KEY",
4     "Accept": "application/json"
5   }
6 });
7 const data = await response.json();

1 require "uri"
2 require "net/http"
3 
4 url = URI("https://api.tamio.com/v2/clients/list")
5 
6 https = Net::HTTP.new(url.host, url.port)
7 https.use_ssl = true
8 
9 request = Net::HTTP::Get.new(url)
10 request["Accept"] = "application/json"
11 request["Authorization"] = "Bearer YOUR_API_KEY"
12 
13 response = https.request(request)
14 puts response.read_body

Responses

{
  "status": 200,
  "total_results": 42,
  "clients": []
}

1	const response = await fetch("https://api.tamio.com/v2/clients/list", {
2	headers: {
3	"Authorization": "Bearer YOUR_API_KEY",
4	"Accept": "application/json"
5	}
6	});
7	const data = await response.json();

1	require "uri"
2	require "net/http"
3
4	url = URI("https://api.tamio.com/v2/clients/list")
5
6	https = Net::HTTP.new(url.host, url.port)
7	https.use_ssl = true
8
9	request = Net::HTTP::Get.new(url)
10	request["Accept"] = "application/json"
11	request["Authorization"] = "Bearer YOUR_API_KEY"
12
13	response = https.request(request)
14	puts response.read_body