List subaccount organizations
3 minute read
GET
Use this endpoint to get details about the organizations in a subaccount.https://www.digicert.com/services/v2/account/subaccount/1389108/organization
Example requests and responses
curl --request GET 'https://www.digicert.com/services/v2/account/subaccount/1389108/organization' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \import requests
url = "https://www.digicert.com/services/v2/account/subaccount/1234567/organization"
payload={}
headers = {
'X-DC-DEVKEY': {{api_key}},
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v2/account/subaccount/1234567/organization"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("X-DC-DEVKEY", {{api_key}})
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}var request = require('request');
var options = {
'method': 'GET',
'url': 'https://www.digicert.com/services/v2/account/subaccount/1234567/organization',
'headers': {
'X-DC-DEVKEY': {{api_key}},
'Content-Type': 'application/json'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});200 OK
{
"organizations": [
{
"id": 12345678,
"status": "active",
"name": "Example Organization",
"display_name": "Example Organization",
"validations": [
{
"type": "ev",
"name": "EV",
"description": "Extended Organization Validation (EV)",
"date_created": "2020-10-23T06:41:34+00:00",
"validated_until": "2021-11-23T07:00:00+00:00",
"status": "active"
},
{
"type": "ov",
"name": "OV",
"description": "Normal Organization Validation",
"date_created": "2020-10-23T06:40:51+00:00",
"validated_until": "2021-11-23T07:00:00+00:00",
"status": "active"
}
]
},
…
]
}
Path parameters
| Name | Type | Description |
|---|---|---|
| subaccount_id | int | ID of the subaccount to query. |
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 name property matches or contains a specific string of characters.Examples: |
| sort | optional | string | Sorts results by the value of one or more properties. By default, sorts 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: |
| limit | optional | int | Total number of results to include in the response. Maximum: 1000 (default) |
| offset | optional | int | Index of the first result to include in the response. Default |
| 0 |
Response parameters
| Name | Type | Description |
|---|---|---|
| organizations | array | List of objects with information about each organization. |
| .. id | int | Organization ID. |
| .. status | string | Organization status. Possible values: active, inactive. For more information, see Glossary – Organization status. |
| .. name | string | Organization legal name. |
| .. display_name | string | Organization display name. |
| .. validations | array | List of objects with details about the validation for the organization. Note: Organizations with no validations do not return a validations array. |
| .. .. type | string | Validation type identifier. Possible values: See Glossary – Validation types |
| .. .. name | string | Name of the validation type. |
| .. .. description | string | Description of the validation type. |
| .. .. date_created | string | Date and time the organization was validated. Format: YYYY-MM-DDThh:mm:ssTZD UTC time zone and ISO 8601 date. |
| .. .. validated_until | string | Date and time the validation expires. Format: YYYY-MM-DDThh:mm:ssTZD UTC time zone and ISO 8601 date. |
| .. .. status | string | Validation status. Possible values: See Glossary – Organization validation statuses. |
| page | object | Object with pagination details. Modified using URL query strings. |
Was this page helpful?
Provide feedback