Only authorized technology partners have access to partner endpoints. To make authorized calls to partner endpoints, you must include your API key in the x-api-key header and the JSON Web Token (JWT) in the Authorization header. The JWT automatically expires in one hour (3,600 seconds) and cannot be refreshed. You must re-authenticate each time a JWT expires.
Make a GET
call to the /partner/accounts
endpoint to get details about all Constant Contact client accounts under your technology partner account.
The following example shows the client account details that the GET /partner/accounts
returns:
{
"site_owner_list": [
{
"encoded_account_id": "a07e1lwvtuw0",
"subscriber_count": 10,
"organization_name": "partner_child01",
"site_owner_name": "Jack Box",
"billing_status": "Trial"
},
{
"encoded_account_id": "a07e1lwvtuv0",
"subscriber_count": 350,
"organization_name": "partner_child02",
"site_owner_name": "Jill Hill",
"billing_status": "Active"
}
],
"_links": {
"next": {
"href": "/v3/partner/accounts?offset=MTA*&limit=10"
}
}
}
Property Name | Description |
---|---|
encoded_account_id |
The obfuscated ID used to uniquely identify a client account. |
subscriber_count |
The total number of subscriber contacts that are associated with a client account. |
organization_name |
The name of the organization associated with this client account. |
site_owner_name |
The user name that identifies a client account. |
billing_status |
The client’s Constant Contact account billing status. Billing status values include: |
- Trial : This is a non-paying trial client account. |
|
- Open : This is an active and paying client account. |
|
- Canceled : The client account was canceled. |
|
- Trial End : The trial period has ended for this client account. |
|
last_login_date |
The system generated date and time (ISO-8601) showing when the client last logged into their Constant Contact account. If they have not logged into their account (the value is null ), the property does not display in the results. |
Parameters
In the limit
path parameter, specify the number of accounts to return on each page of results. The default value is 50
. Entering a limit
value less than the minimum (10
) or greater than the maximum (50
) is ignored and the system uses the default values. Depending on the limit
you specify, the system determines the offset
parameter to use (number of records to skip) and includes it in the link used to get the next page of results.
Use the account_type
query parameter to filter client account results by account type: all
(default), managed
, or unmanaged
. Excluding the account_type
query parameter returns all client accounts.
Example GET Partner Client Accounts Request
GET https://api.cc.email/v3/partner/accounts?limit=50
<?php
$request = new HttpRequest();
$request->setUrl('https://api.cc.email/v3/partner/accounts?limit=50&account_type=managed');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData(array(
'limit' => '50'
));
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Connection' => 'keep-alive',
'Accept-Encoding' => 'gzip, deflate',
'Host' => 'your_host',
'Cache-Control' => 'no-cache',
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'xxxxxxxxxxxxxxxxxxxxxxxxpWQzZGTG9DS0RGTkYzT2w0XC9KaDU2TUFtc3RnQT0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI2cjZ0bzVmb2UxZ2luNWt0N3Y2Y2JoanNjcyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoidjNhcGlcL2dlbmVyYWwucGFydG5lciIsImF1dGhfdGltZSI6MTU4ODY5ODcwMSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfTUd4alFNTTRQIiwiZXhwIjoxNTg4NzAyMzAxLCJpYXQiOjE1ODg2OTg3MDEsInZlcnNpb24iOjIsImp0aSI6IjUyMDNmOGY5LTgzOTAtNDkzNS05OGJjLTdhOGJmNzg4YjgyYiIsImNsaWVudF9pZCI6IjZyNnRvNWZvZTFnaW41a3Q3djZjYmhqc2NzIn0.DTZoeyPuXoPFhHQZCCciDxxxxxxxxxxxxxxxxx-T9Yig046s2DRyKc5b3SKI5b33T5i5zlk-0iN7mliwZ3yNS3jX-XMFELA303aFPln38YARElItnqUt3hafiGBqopDIe3MbYYDsI8-VwtyIYdLUQo1AVr5dhxtQnIsQ8VxI-65s_kiOFRvEmeQk8fav4dO3cnuDspd9zKEEEDcPVooCGJROxeEFu1Ab8r3S5Eba_By3rFFm6rMGURltADM52QiAfhqJRtQJUO8E5Ae7RWi_0191B9s8tChtFfxxxxxxxxxxxxxxxxxxxxxx' ,
'x-api-key' => '3d4dp123-123b-436d-97c3-0f0f502218f1'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.cc.email/v3/partner/accounts?limit=50&account_type=managed")
.get()
.addHeader("x-api-key", "3d4dp123-123b-436d-97c3-0f0f502218f1")
.addHeader("Authorization", "xxxxxxxxxxxxxxxxxxxxxxxxpWQzZGTG9DS0RGTkYzT2w0XC9KaDU2TUFtc3RnQT0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI2cjZ0bzVmb2UxZ2luNWt0N3Y2Y2JoanNjcyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoidjNhcGlcL2dlbmVyYWwucGFydG5lciIsImF1dGhfdGltZSI6MTU4ODY5ODcwMSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfTUd4alFNTTRQIiwiZXhwIjoxNTg4NzAyMzAxLCJpYXQiOjE1ODg2OTg3MDEsInZlcnNpb24iOjIsImp0aSI6IjUyMDNmOGY5LTgzOTAtNDkzNS05OGJjLTdhOGJmNzg4YjgyYiIsImNsaWVudF9pZCI6IjZyNnRvNWZvZTFnaW41a3Q3djZjYmhqc2NzIn0.DTZoeyPuXoPFhHQZCCciDxxxxxxxxxxxxxxxxx-T9Yig046s2DRyKc5b3SKI5b33T5i5zlk-0iN7mliwZ3yNS3jX-XMFELA303aFPln38YARElItnqUt3hafiGBqopDIe3MbYYDsI8-VwtyIYdLUQo1AVr5dhxtQnIsQ8VxI-65s_kiOFRvEmeQk8fav4dO3cnuDspd9zKEEEDcPVooCGJROxeEFu1Ab8r3S5Eba_By3rFFm6rMGURltADM52QiAfhqJRtQJUO8E5Ae7RWi_0191B9s8tChtFfxxxxxxxxxxxxxxxxxxxxxx' ")
.addHeader("Accept", "*/*")
.addHeader("Content-Type", "application/json")
.addHeader("Cache-Control", "no-cache")
.addHeader("Host", "your_host")
.addHeader("Accept-Encoding", "gzip, deflate")
.addHeader("Connection", "keep-alive")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
curl --request GET \
--url 'https://api.cc.email/v3/partner/accounts?limit=50&account_type=managed' \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Authorization: xxxxxxxxxxxxxxxxxxxxxxxxpWQzZGTG9DS0RGTkYzT2w0XC9KaDU2TUFtc3RnQT0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI2cjZ0bzVmb2UxZ2luNWt0N3Y2Y2JoanNjcyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoidjNhcGlcL2dlbmVyYWwucGFydG5lciIsImF1dGhfdGltZSI6MTU4ODY5ODcwMSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfTUd4alFNTTRQIiwiZXhwIjoxNTg4NzAyMzAxLCJpYXQiOjE1ODg2OTg3MDEsInZlcnNpb24iOjIsImp0aSI6IjUyMDNmOGY5LTgzOTAtNDkzNS05OGJjLTdhOGJmNzg4YjgyYiIsImNsaWVudF9pZCI6IjZyNnRvNWZvZTFnaW41a3Q3djZjYmhqc2NzIn0.DTZoeyPuXoPFhHQZCCciDxxxxxxxxxxxxxxxxx-T9Yig046s2DRyKc5b3SKI5b33T5i5zlk-0iN7mliwZ3yNS3jX-XMFELA303aFPln38YARElItnqUt3hafiGBqopDIe3MbYYDsI8-VwtyIYdLUQo1AVr5dhxtQnIsQ8VxI-65s_kiOFRvEmeQk8fav4dO3cnuDspd9zKEEEDcPVooCGJROxeEFu1Ab8r3S5Eba_By3rFFm6rMGURltADM52QiAfhqJRtQJUO8E5Ae7RWi_0191B9s8tChtFfxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Cache-Control: no-cache' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/json' \
--header 'Host: your_host' \
--header 'cache-control: no-cache' \
--header 'x-api-key: 3d4dp123-123b-436d-97c3-0f0f502218f1'
View it! Although technology partner endpoints cannot be tested using our API Reference tester, response samples and schema are available for this endpoint.