List orders

GET https://www.digicert.com/services/v2/order/certificate

Use this endpoint to list all certificate orders.

Notice

Change the ACCEPT header to text/csv to return a CSV output of the results.

Example requests and responses

Example 1. cURL

curl -X GET \
  https://www.digicert.com/services/v2/order/certificate \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Example 2. Python

import requests

url = "https://www.digicert.com/services/v2/order/certificate"

headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example 3. Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate"

	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))

}

Example 4. NodeJS

var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/order/certificate',
  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);
});

Example 5. 200 OK

{
  "orders": [
    {
      "id": 123456,
      "certificate": {
        "id": 104,
        "common_name": "example.com",
        "dns_names": [
          "example2.com",
          "example3.com"
        ],
        "signature_hash": "sha256"
      },
      "status": "pending",
      "is_renewed": false,
      "date_created": "2018-10-16T17:29:56+00:00",
      "organization": {
        "id": 112233,
        "name": "Epigyne Unwieldiness llc"
      },
      "validity_years": 1,
      "disable_renewal_notifications": false,
      "container": {
        "id": 14,
        "name": "DigiCert Inc."
      },
      "product": {
        "name_id": "ssl_plus",
        "name": "Standard SSL",
        "type": "ssl_certificate"
      },
      "has_duplicates": false,
      "product_name_id": "ssl_plus"
    },
    {
      "id": 123457,
      "certificate": {
        "id": 105,
        "common_name": "example.org",
        "dns_names": [
          "sub.example.org"
        ],
        "valid_till": "2020-04-30",
        "days_remaining": 289,
        "signature_hash": "sha256"
      },
      "status": "issued",
      "is_renewed": false,
      "date_created": "2019-04-30T18:02:50+00:00",
      "organization": [],
      "validity_years": 1,
      "container": {
        "id": 14,
        "name": "CertCentral"
      },
      "product": {
        "name_id": "ssl_dv_geotrust",
        "name": "GeoTrust Standard DV",
        "type": "dv_ssl_certificate"
      },
      "has_duplicates": false,
      "product_name_id": "ssl_dv_geotrust"
    },
    ...
  ],
  "page": {
    "total": 31,
    "limit": 0,
    "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[id]` `filters[status]`: Use `pending`, `issued`, `rejected`, `revoked`, `waiting_pickup`, `reissue_pending`, `canceled`, or `active_issued`. Note: The `issued` status filter includes any order where the certificate has been issued, even if the order has expired. The `active_issued` status filter lists only orders that are currently in the issued status (that is, still active and not expired). `filters[organization_id]` `filters[product_name_id]`: See Glossary – Product identifiers. `filters[valid_till]` `filters[user_id]` `filters[common_name]`: Limits results to orders with the given `common_name` value. `filters[domain_name]`: Limits results to orders where either the `common_name` field or the `dns_names` array contains the given domain name. `filters[date_created]` `filters[container_id]` `filters[metadata_id]` `filters[is_renewed]`: Use `1` for true or `0` for false. `filters[disable_renewal_notifications]`: Use `1` for true or `0` for false. `filters[email]` `filters[certificate_id]` `filters[origin]`: Use `certcentral` or `migrated`. `filters[serial_number]`: Limits results to the order with the certificate that has the given serial number.
filters[search]	optional	string	Limits response to results where the value of the `email` or `common_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: `filters[search]=%25gmail` Limits response to results where the value of a searched property contains the string `gmail`. `filters[search]=myname@gmail.com` Limits response to results where the value of a searched property is an exact match for the string `myname@gmail.com`.
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: `order_id` `status` `organization_id` `product_name_id` `user_id` `common_name` `date_created` `container_id` `is_renewed` `disable_renewal_notifications` `email`
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
orders	array	List of orders returned by the request.
.. id	int	Order ID.
.. certificate	object	Details about the certificate ordered.
.. .. id	int	Certificate ID.
.. .. common_name	string	Name secured by the certificate.
.. .. dns_names	array	List of additional names secured by the certificate.
.. .. valid_till	string	Expiration date of the certificate. Format:`yyyy-MM-dd`
.. .. days_remaining	int	Number of days until certificate expires.
.. .. signature_hash	string	Signing algorithm used by the certificate.
.. status	string	Status of the order. See Glossary – Order status.
.. is_renewed	bool	Specifies if the order has been renewed.
.. date_created	string	Order creation date. Format: UTC timezone and ISO 8601 date
.. organization	object	Details about the organization associated with the order.
.. .. id	int	Organization ID.
.. .. name	string	Legal name of the organization.
.. validity_years	int	Number of years the certificate will be valid.
.. disable_renewal_notifications	bool	Specifies if renewal notifications are enabled.
.. container	object	Details about the container associated with the order.
.. .. id	int	Container ID.
.. .. name	string	Name of the container.
.. product	object	Details about the ordered product.
.. .. name_id	string	Name ID of the product. See Glossary – Product identifiers.
.. .. name	string	Display name of the product. See Glossary – Product identifiers.
.. .. type	string	Product type. See Glossary – Product types.
.. duplicates_count	int	Number of duplicate certificates associated with the order.
.. has_duplicates	bool	Specifies if there are duplicates.
.. reissues_count	int	Number of reissued certificates associated with the order.
.. has_reissues	bool	Specifies if there are reissues.
.. product_name_id	string	Name ID of the product. See Glossary – Product identifiers.
page	object	Details about results. Modified using URL query strings.

In this section: