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 object

Start date for filtering clients by registration date. Accepts an ISO 8601 date string or a Unix timestamp.

to object

End date for filtering clients by registration date. Accepts an ISO 8601 date string or a Unix timestamp.

product_id string

Filter clients by a product they are associated with

countries[] array of string

Filter clients by two-letter country codes. Pass multiple times for multiple countries (e.g. ?countries[]=de&countries[]=fr).

Responses

200 Clients listed successfully

Clients listed successfully

status integer

total_results integer

Total number of matching clients

clients array of Client

id string

Unique identifier for the client

object string

Object type identifier

customer_id string

UUID of the associated customer record

email string

Primary contact email address

telephone string

Contact telephone number

name string

Company or client name

country string

Two-letter country code

locale string

Dashboard locale setting

status string

Current client status

demoactiveaffiliatesuspendedinactive

is_demo boolean

Whether the client is a demo account

is_suspended boolean

Whether the client is suspended

registration_date integer

Registration date as Unix timestamp

admin object

Agency/admin user managing this client (null if managed by Tamio)

id integer

Admin user ID

email string

Admin email address

name string

Admin company name

business_information BusinessInformation

billing_plan BillingPlan

quotas Quotas

permissions object

Permission settings controlling access to various system features. Each key is a feature area containing boolean permission flags (view, edit, create, remove, publish). Not all actions apply to every feature area.

account object

Permissions for account settings and profile management

view boolean

edit boolean

remove boolean

billing object

Permissions for billing, invoices, and payment management

view boolean

edit boolean

keys object

Permissions for API keys and authentication tokens

view boolean

edit boolean

create boolean

remove boolean

webhooks object

Permissions for webhook configuration and management

view boolean

edit boolean

create boolean

remove boolean

logs object

Permissions for viewing system logs

view boolean

audit_trail object

Permissions for viewing audit trail and change history

view boolean

revenue_analytics object

Permissions for revenue analytics and financial reports

view boolean

source_analytics object

Permissions for source analytics and traffic attribution

view boolean

visitor_analytics object

Permissions for visitor analytics and user behavior data

view boolean

domains object

Permissions for domain management

view boolean

edit boolean

create boolean

remove boolean

taxes object

Permissions for tax configuration and rules

view boolean

edit boolean

create boolean

remove boolean

teammates object

Permissions for team member management

view boolean

edit boolean

create boolean

remove boolean

reports object

Permissions for reports and analytics

view boolean

edit boolean

sites object

Permissions for website management

view boolean

edit boolean

create boolean

remove boolean

publish boolean

pages object

Permissions for page management and content editing

view boolean

edit boolean

create boolean

remove boolean

affiliate_programs object

Permissions for affiliate program management

view boolean

edit boolean

create boolean

remove boolean

affiliates object

Permissions for affiliate user management

view boolean

edit boolean

remove boolean

affiliate_network object

Permissions for affiliate network settings

view boolean

edit boolean

payouts object

Permissions for affiliate payouts and payments

view boolean

edit boolean

create boolean

remove boolean

payments object

Permissions for payment processing and transactions

view boolean

edit boolean

remove boolean

integrations object

Permissions for third-party integrations

view boolean

edit boolean

create boolean

remove boolean

publish boolean

invoices object

Permissions for invoice management

view boolean

edit boolean

create boolean

remove boolean

subscriptions object

Permissions for subscription management

view boolean

edit boolean

remove boolean

instalment_plans object

Permissions for instalment plan management

view boolean

edit boolean

remove boolean

customers object

Permissions for customer management

view boolean

edit boolean

create boolean

remove boolean

subscribers object

Permissions for email subscriber management

view boolean

edit boolean

create boolean

remove boolean

mailing_lists object

Permissions for mailing list management

view boolean

edit boolean

create boolean

remove boolean

automations object

Permissions for automation workflow management

view boolean

edit boolean

create boolean

remove boolean

discounts object

Permissions for discount code management

view boolean

edit boolean

create boolean

remove boolean

email_templates object

Permissions for email template management

view boolean

edit boolean

create boolean

remove boolean

reviews object

Permissions for customer review management

view boolean

edit boolean

remove boolean

assets object

Permissions for media asset management

view boolean

edit boolean

create boolean

remove boolean

products object

Permissions for product and inventory management

view boolean

edit boolean

create boolean

remove boolean

shippings object

Permissions for shipping method management

view boolean

edit boolean

create boolean

remove boolean

warehouses object

Permissions for warehouse and inventory location management

view boolean

edit boolean

create boolean

remove boolean

support object

Permissions for support ticket management

view boolean

edit boolean

create boolean

remove boolean

clients object

Permissions for client account management

view boolean

edit boolean

create boolean

remove boolean

agency_billing_plans object

Permissions for agency billing plan management

view boolean

edit boolean

create boolean

remove boolean

ai object

Permissions for AI features and content generation

view boolean

edit boolean

create boolean

remove boolean

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`1002`	The provided product ID does not match any existing product

status integer

error string

error_code integer

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": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "object": "client",
      "customer_id": "660e8400-e29b-41d4-a716-446655440000",
      "email": "[email protected]",
      "telephone": "+49123456789",
      "name": "Acme Corp",
      "country": "de",
      "locale": "en",
      "status": "active",
      "is_demo": false,
      "is_suspended": false,
      "registration_date": 1700000000,
      "admin": {
        "id": 12345,
        "email": "[email protected]",
        "name": "My Agency"
      },
      "business_information": {
        "name": "Acme Online Store",
        "country": "gr",
        "address": "123 Test Street",
        "city": "Athens",
        "postcode": "10431",
        "state": "Attica",
        "offset": "+02:00",
        "telephone": "+30 210 1234567",
        "vat": "123456789",
        "default_currency": "EUR",
        "email": "[email protected]",
        "currency_conversion": true,
        "custom_fields": [
          "Industry",
          "Registration Number"
        ],
        "currencies": [
          "EUR",
          "USD",
          "GBP"
        ],
        "languages": [
          "en",
          "de"
        ],
        "locale": "en",
        "logos": {}
      },
      "billing_plan": {
        "id": "770e8400-e29b-41d4-a716-446655440000",
        "object": "subscription",
        "status": "active",
        "type": "subscription",
        "gateway": "stripe",
        "gateway_subscription_id": "sub_1N2m3o4P5q6R7s",
        "billing_cycle": "month",
        "interval": 1,
        "currency": "EUR",
        "price": 2990,
        "lifetime_revenue": 35880,
        "payment_count": 12,
        "has_discount": false,
        "next_billing_date": 1703000000,
        "cancellation_date": null,
        "completion_date": null,
        "resumes_at": null,
        "invoice_id": "880e8400-e29b-41d4-a716-446655440000",
        "instalments_count": 0,
        "imported": false,
        "has_notes": false,
        "products": [],
        "customer": {}
      },
      "quotas": {
        "used_storage": 52428800,
        "storage_quota": 1073741824,
        "used_datatransfer": 5368709120,
        "datatransfer_quota": 107374182400,
        "used_automations": 3,
        "automations_quota": 10,
        "remaining_automations_quota": 7,
        "used_transactions": 15,
        "transaction_quota": 100,
        "used_products": 45,
        "products_quota": 100,
        "used_languages": 2,
        "languages_quota": 3,
        "used_domains": 1,
        "domains_quota": 3,
        "used_currencies": 2,
        "currencies_quota": 3,
        "used_teammates": 5,
        "teammates_quota": 10,
        "used_api": 1250,
        "api_quota": 10000,
        "used_newsletters": 500,
        "newsletters_quota": 1000,
        "used_clients_accounts": 3,
        "client_accounts_quota": 5,
        "used_ai": 25,
        "ai_quota": 100,
        "remaining_ai_quota": 75,
        "used_sms_balance": 50,
        "sms_balance": 200,
        "remaining_sms_balance": 150,
        "email_accounts_quota": 30,
        "used_email_accounts": 12,
        "default_email_slots_per_mailbox": 10,
        "root": {}
      },
      "permissions": {
        "account": {
          "view": true,
          "edit": true,
          "remove": false
        },
        "billing": {
          "view": true,
          "edit": false
        },
        "keys": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "webhooks": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "logs": {
          "view": true
        },
        "audit_trail": {
          "view": true
        },
        "revenue_analytics": {
          "view": true
        },
        "source_analytics": {
          "view": true
        },
        "visitor_analytics": {
          "view": true
        },
        "domains": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "taxes": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "teammates": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "reports": {
          "view": true,
          "edit": true
        },
        "sites": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true,
          "publish": true
        },
        "pages": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "affiliate_programs": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "affiliates": {
          "view": true,
          "edit": true,
          "remove": true
        },
        "affiliate_network": {
          "view": true,
          "edit": true
        },
        "payouts": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "payments": {
          "view": true,
          "edit": true,
          "remove": true
        },
        "integrations": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true,
          "publish": true
        },
        "invoices": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "subscriptions": {
          "view": true,
          "edit": true,
          "remove": true
        },
        "instalment_plans": {
          "view": true,
          "edit": true,
          "remove": true
        },
        "customers": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "subscribers": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "mailing_lists": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "automations": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "discounts": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "email_templates": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "reviews": {
          "view": true,
          "edit": true,
          "remove": true
        },
        "assets": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "products": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "shippings": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "warehouses": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "support": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "clients": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "agency_billing_plans": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        },
        "ai": {
          "view": true,
          "edit": true,
          "create": true,
          "remove": true
        }
      }
    }
  ]
}

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