v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Certificates

Get Certificates

Returns a list of tenant certificates.

get/v1/certificates

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of tenant certificates.

certificateIdinteger

The identifier for the certificate definition.

certificateNamestring

The name of the certificate.

certificateCategoryIdinteger

The identifier for the certificate category.

certificateCategorynamestring

The certificate category name.

isArchiveboolean

True or false value if the certificate is archived or not.

archivedByUserIdinteger

The identifier for the user that archived the certificate.

archivedDatestring date-time

The date the certificate was archived. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

frontOfficeTenantIdinteger

The unique identifier that represents a client.

Example response

[
  {
    "certificateId": 284,
    "certificateName": "Tetanus vaccination",
    "certificateCategoryId": 635,
    "certificateCategoryname": "Vaccinations",
    "certificateAuthorities": [
      {
        "certificateAuthorityId": 248,
        "certificateAuthorityName": "America - MN",
        "archivedByUserId": 13991
      }
    ],
    "archivedByUserId": 118476,
    "frontOfficeTenantId": 796
  }
]