GET Certificate Collections

The GET /CertificateCollections operation returns a list of all certificate collections. Query parameters support filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. On success, the operation returns HTTP 200 OK with  details about each defined certificate collectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be available in other places in the Management Portal (for example expiration alerts and certain reports)..

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificates/collections/read/
OR
/certificates/collections/read/#/

Permissions for certificates can be set at the system-wide or resource-specific level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions and Application Permissions for more information.

In permission strings, # represents a specific resource identifier. In /certificates/collections/ permission strings it refers to a certificate collection ID (for example, CollectionId) and in /certificate_stores/ permission strings it refers to a certificate store application ID (for example, containerId).

Table 379: GET Certificate Collections Input Parameters

Name In

Description
QueryString Query

A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Searching Certificates. The query fields supported for this operation are:

  • ExcludeUserSpecificCollections

    If True, collections with queries that contain user-specific conditionals are excluded from the results. User-specific conditionals include %ME%, %ME-AN%, and %ROLES%. The default is False.

  • LastEstimated

    Finds collections by the date when the cached collection data was last generated by the automated scheduled task.

  • Name

    Finds collections by display name.

  • Query

    Finds collections by the query that defines the collection.
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include:

  • Automated

  • Content

  • Description

  • DuplicationField

  • EstimatedCertCount

  • Id

  • LastEstimated

  • Name

  • ShowOnDashboard

Available sort fields are affected by the query provided in QueryString. The default sort field is Name.
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 380: GET Certificate Collections Response Data

Name Description
ID The Keyfactor Command reference ID for the certificate collection. The ID is automatically assigned by Keyfactor Command.
Name The name for the certificate collection. This name appears at the top of the page in the Keyfactor Command Management Portal for this collection and can be configured to appear on the Management Portal menu under Certificate Collections. It will also appear in other places within the Management Portal where you can reference certificate collections (for example, expiration alerts and certain reports). Because it can appear on the menu and in selection dropdowns, the name should be fairly short.
Description The description for the collection. This description appears at the top of the page in the Management Portal for this collection and can be more detailed than the collection name.
Automated An internally used Keyfactor Command field.
Content

A string containing the search criteria for the collection.

DuplicationField

An integer that sets the type of de-duplication (a.k.a. ignore renewed certificate results by) to apply to the collection when using the collection in areas of Keyfactor Command that apply de-duplication (for example, expiration alerts). For more information, see Save Search Criteria as a Collection. ClosedShow duplication field details.
ShowOnDashboard A Boolean that sets whether the results from this collection are included on the Management Portal legacy dashboard Certificate Counts by Collection graph (True or False).
Favorite A Boolean that sets whether the collection appears on the Navigator (True or False).
EstimatedCertCount An integer that is representative of the number of certificates that have been processed by theQueryItemsPopulator timer service. It is queryable but not sortable.
LastEstimated A date formatted as MM/DD/YYYY hh:mm (for example, 12/11/2025 12:45 PM) representing the last time the collection was processed, when the QueryItemsPopulator timer service job last ran.
Tip:  See the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.