List subaccounts
3 minute read
GET
Use this endpoint to list all subaccounts.https://www.digicert.com/services/v2/account/subaccount
Example requests and responses
curl -X GET \
https://www.digicert.com/services/v2/account/subaccount \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'import requests
url = "https://www.digicert.com/services/v2/account/subaccount"
payload = ""
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/json"
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v2/account/subaccount"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}var request = require("request");
var options = { method: 'GET',
url: 'https://www.digicert.com/services/v2/account/subaccount',
headers:
{ 'Content-Type': 'application/json',
'X-DC-DEVKEY': '{{api_key}}' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});200 OK
{
"subaccounts": [
{
"account_id": 112233,
"account_type": "reseller",
"organization_name": "Number one organization",
"date_created": "2018-11-29 01:48:04",
"account_manager": "Jim James"
},
{
"account_id": 112234,
"account_type": "enterprise",
"organization_name": "Number two organization",
"date_created": "2018-11-29 18:25:04",
"account_manager": "Jill Valentine"
},
{
"account_id": 112235,
"account_type": "retail",
"organization_name": "Number three organization",
"date_created": "2018-12-04 15:24:43",
"account_manager": "Rick Roll"
}
],
"page": {
"total": 3,
"limit": 1000,
"offset": 0
}
}
Filters and URL query parameters
This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API - Filters, sorting, and pagination parameters.
| Name | Req/Opt | Type | Description |
|---|---|---|---|
filters[{{property_name}}] | optional | string | Filters results by the specified property. Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties: |
| filters[search] | optional | string | Limits response to results where the value of the organization_name property matches or contains a specific string of characters.To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: %25. To search for values that are an exact match for a string of characters, omit the %25 from the request.Examples: |
| sort | optional | string | Sorts results by the value of one or more properties. By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus ( -).To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list. This endpoint supports sorting by the following properties: |
| offset | optional | int | Index of the first result to include in the response. Default: |
| 0 | |||
| limit | optional | int | Total number of results to include in the response. Max: 1000 (default) |
Response parameters
| Name | Type | Description |
|---|---|---|
| child_accounts | array | List of all subaccounts. |
| .. account_id | int | Account ID. |
| .. account_type | string | Defines the subaccount type. See Glossary – Subaccount types. |
| .. organization_name | string | Legal name of the subaccount’s primary organization. |
| .. date_created | string | Timestamp of when the subaccount was created. Format: |
| yyyy-MM-dd HH:mm:ss | ||
| .. account_manager | string | Name of the subaccount’s account representative. |
| page | object | Details about results. Modified using URL query strings. |
Was this page helpful?
Provide feedback