Returns all client configurations you have access to, including their individual settings.
data is an array of client JSON objects, each describing a client which your
API key as access to.
| name | type | description |
|---|---|---|
| id | string | Client ID that you can use in other API endpoints |
| locale | string | locale, for example “en” |
| display_name | string | Name of client |
| email_name | string | Name used as default From name in emails |
| account_name | string | Name of account that this client is associated with |
| contact_email | string | Email address for your customer support |
| contact_url | string | URL for customer support |
| send_emails_after_days | integer | Default minimum number of days to wait after order to send review request |
| send_emails_before_days | integer | Maximum number of days to wait after order to send review request |
| send_limit | boolean | Maximum number of emails to review request emails to send per day, can not be set higher than your contract allows |
| quarantine_period | integer | Quarantine period in days, only send one email to a customer during this period. Default is 21 days. |
| min_review_words | integer | Require a minimum of this many words in review texts |
| min_review_words_promoter | integer | Require a minimum of this many words in review texts from verified buyers for 4-star and 5-star reviews |
| collect_seller_reviews | boolean | Collect seller reviews |
| collect_pros_cons | boolean | Collect Pros & Cons |
| collect_questions | boolean | Collect Questions & Answers |
| collect_recommended | boolean | Ask if user recommends this product |
| own_moderation | boolean | If true, client handles moderation in-house |
| auto_moderate | boolean | If true, moderation is automatic, ask TestFreaks for details |
| require_verification | boolean | Require email address verification |
| must_agree_to_terms | boolean | Ask verified buyers to check a box that they agree to terms |
| must_agree_to_terms_web | boolean | Ask non-verified buyers to check a box that they agree to terms |
| external_review_locale | string | Display reviews from external source with these locales (comma-separated string of locales) |
| external_review_countries | string | Display reviews from external source with these countries (comma-separated string of country codes |
| external_pro_reviews | boolean | Display expert reviews from external sources |
| external_user_reviews | boolean | Display user reviews from external sources |
| expand_family | boolean | If true, display APIs will automatically group reviews by family ID |
| config | object | Email template settings, ask our support for details |
If .links.next is set, additional pages are available by following the link.
$ curl -u sk_token: https://api.testfreaks.com/v1/clients
{
"data": [
{
"id": "client-id1",
"locale": "en",
"display_name": "Name",
"email_name": "Name",
"account_name": "Name",
"contact_email": "info@retailer.example",
"contact_url": "https://retailer.example/customer-service/",
"send_emails_after_days": 30,
"send_emails_before_days": 100,
"send_limit": 2000,
"quarantine_period": null,
"min_review_words": null,
"min_review_words_promoter": null,
"collect_seller_reviews": false,
"collect_pros_cons": true,
"collect_questions": false,
"collect_recommended": false,
"own_moderation": false,
"auto_moderate": false,
"require_verification": true,
"must_agree_to_terms": false,
"must_agree_to_terms_web": true,
"external_review_locale": "en-US",
"external_review_countries": null,
"external_pro_reviews": false,
"external_user_reviews": false,
"expand_family": false,
"config": {}
},
{
"id": "client-id2",
"locale": "sv",
"display_name": "Name",
"email_name": "Name",
"account_name": "Name",
"contact_email": "info@example.se",
"contact_url": "https://example.se/customer-service/",
"send_emails_after_days": 30,
"send_emails_before_days": 100,
"send_limit": 2000,
"quarantine_period": null,
"min_review_words": null,
"min_review_words_promoter": null,
"collect_seller_reviews": false,
"collect_pros_cons": true,
"collect_questions": false,
"collect_recommended": false,
"own_moderation": false,
"auto_moderate": false,
"require_verification": true,
"must_agree_to_terms": false,
"must_agree_to_terms_web": true,
"external_review_locale": "sv-SE",
"external_review_countries": null,
"external_pro_reviews": false,
"external_user_reviews": false,
"expand_family": false,
"config": {}
}
]
}