Get a collection of certificates.

Note: Certificates with the following status are not returned by this method:

  • APPROVED
  • DECLINED

​
Basic Parameters

ParameterDescription
Certificate TypeFilter certificates by certificate type.This parameter accepts:* Exact values.* Multiple values using the in: operator.Examples:* SMIME_ENT* in:STANDARD_SSL,ADVANTAGE_SSL,EV_SSL
Distinguished NameFilter certificates by distinguished name.This parameter accepts:* Exact values.* Partial matches using the con: operator.* Multiple values using the in: operator.Examples:* Marketing* con:Marketing* con:ou=Marketing
Domain UsedFilter certificates by domain name used.This parameter accepts:* Exact values.* Partial matches using the con: operator.* Multiple values using the in: operator.Examples:* entrust.com* con:entrust
Expiration TimeFilter certificates with a specific date and time of expiry.Use the Expires After Relation parameter to find certificates expiring before or after the specified date.
Expires After RelationDefines how to compare certificate expiration dates against the specified Expiration Time.
FieldsSpecify the certificate fields to include in the response.Insert a comma-separated list of field names or * for all available fields.Examples:* trackingId,dn,status* trackingId,dn,serialNumber,expiresAfter,signingAlg,eku,status* *
LimitThe maximum number of items to return per request.Maximum value: 1000
OffsetThe index of the first result to return.
OrganizationFilter certificates by organization.This parameter accepts:* Exact values.* Partial matches using the con: operator.* Multiple values using the in: operator.Examples:* Entrust Datacard* con:Entrust
Organizational UnitFilter certificates by organizational unit.This parameter accepts:* Exact values.* Partial matches using the con: operator.* Multiple values using the in: operator.Examples:* Development* con:Marketing
StatusFilter certificates based on their current status.
Subject Alternative NameFilter certificates by subject alternative name (SAN).This parameter accepts:* Exact values.* Partial matches using the con: operator.* Multiple values using the in: operator.Examples:* www.entrust.com* admin@entrust.com* con:entrust.com (matches dev.entrust.com, www.entrust.com, etc.)

​
Advanced Parameters

ParameterDescription
Extended key usageFilter certificates by extended key usage.This parameter accepts:* Exact values.* Multiple values using the in: operator.Examples:* CLIENT_AUTH* in:SERVER_AUTH,SERVER_AND_CLIENT_AUTH
Incident AffectedSelect to filter certificates affected by the incidents provided in the Incident Identifier parameter.
Incident IdentifierFilter certificates by incident identifier.This parameter accepts:* Exact values.* Partial matches using the con: operator.Examples:* CIR20180722-01* con:CIR20180722
Is Third PartySelect to get a list of all foreign certificates.
Issue Data-TimeFilter certificates by issue date and time.Use with the Issue Date-Time Relation parameter to find certificates issued before or after a specific date.
Issue Date-Time RelationDefine how to compare certificate issue dates against the specified Issue Date-Time.
Key SizeFilter certificates by key size in bits.This parameter accepts:* Exact values.* Comparison operators: gt: (greater than), ge: (greater than or equal), lt: (less than), le: (less than or equal).Examples:* 2048* lt:2048 (less than 2048 bits)
Key TypeSelect key types to filter certifications by.
Request Date-TimeFilter certificates by issue date and time.Use with the Request Date-Time Relation parameter to filter by when certificates were requested.
Request Date-Time RelationDefines how to compare certificate request dates against the specified Request Date-Time.
Serial NumberFilter certificates by serial numbers.This parameter accepts:* Exact values.* Partial matches using the con: operator.* Multiple values using the in: operator.Examples:* 239010FB4DD0FD050000000053DA5896* con:53DA5896* in:239010FB4DD0FD050000000053DA5896,4EDBA588DB08C8600000000053DA889CNote: Leading zeros must be stripped from serial numbers before they can be used.
Signing AlgorithmFilter certificates by signing algorithm.This parameter accepts:* Exact values.* Partial matches using the con: operator.* Multiple values using the in: operator.Examples:* SHA-1* in:SHA-1,SHA-2
SortSpecify a sort order for the results.Use field names with optional direction (asc/desc). For example, use trackingId:desc to sort by tracking ID (descending).Note: The uri field is not sortable.

​
Example Output

{
	"summary": {
		"timestamp": "2018-03-13T13:12:12.340Z",
		"elapsed": 380,
		"offset": 1,
		"limit": 1000,
		"total": 2300,
		"sort": "trackingId:desc"
	},
	"certificates": [
		{
			"trackingId": 0,
			"status": "ACTIVE",
			"dn": "string",
			"serialNumber": "string",
			"subjectAltName": [
				{
					"type": "otherName",
					"value": "string"
				}
			],
			"issueDateTime": "2025-04-06T14:23:05.251Z",
			"expiresAfter": "2025-04-06T14:23:05.251Z",
			"signingAlg": "string",
			"eku": "string",
			"keySize": 0,
			"keyType": "RSA",
			"org": "string",
			"ou": [
				"string"
			],
			"certType": "string",
			"tracking": {
				"trackingInfo": "string",
				"customFields": {
					"text1": "string",
					"text2": "string",
					"text3": "string",
					"text4": "string",
					"text5": "string",
					"text6": "string",
					"text7": "string",
					"text8": "string",
					"text9": "string",
					"text10": "string",
					"text11": "string",
					"text12": "string",
					"text13": "string",
					"text14": "string",
					"text15": "string",
					"number1": 0,
					"number2": 0,
					"number3": 0,
					"number4": 0,
					"number5": 0,
					"date1": "2025-04-06",
					"date2": "2025-04-06",
					"date3": "2025-04-06",
					"date4": "2025-04-06",
					"date5": "2025-04-06",
					"email1": "user@example.com",
					"email2": "user@example.com",
					"email3": "user@example.com",
					"email4": "user@example.com",
					"email5": "user@example.com",
					"dropdown1": "string",
					"dropdown2": "string",
					"dropdown3": "string",
					"dropdown4": "string",
					"dropdown5": "string"
				},
				"requesterName": "string",
				"requesterEmail": "user@example.com",
				"requesterPhone": "string",
				"additionalEmails": [
					"user@example.com"
				],
				"deactivated": true,
				"deactivatedOn": "2025-04-06T14:23:05.251Z"
			},
			"domainUsed": "string",
			"isThirdParty": true,
			"thumbprint": "string",
			"vmcHostingDetails": [
				{
					"domain": "example.com",
					"certificateUrl": "https://bimi.entrust.net/example.com/certificatechain.pem",
					"logoUrl": "https://bimi.entrust.net/example.com/logo.svg"
				}
			],
			"requestDateTime": "2025-04-06T14:23:05.251Z",
			"renewalInfo": {
				"retryAfter": "21600",
				"suggestedWindow": {
					"start": "2021-01-03T00:00:00Z",
					"end": "2021-01-07T00:00:00Z"
				},
				"explanationURL": "https://www.entrust.net/ari/CIR20240529-00"
			},
			"incidentAffected": true,
			"incidentIdentifierList": [
				"CIR20240722-01",
				"CIR20240722-02",
				"CIR20240802-01"
			],
			"uri": "/enterprise/v2/certificates/5555555"
		}
	]
}

​
Workflow Library Example

Get Certificates with Entrust Certificate Services and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?