Skip to main content
GET
List an entity's SAT certificates

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId
string<uuid>
required

Query Parameters

id[lt]
string

Collection cursor pointer to the next page

id[gt]
string

Collection cursor pointer to the previous page

itemsPerPage
integer
default:20

Number of items per page

Required range: 1 <= x <= 1000
validFrom[before]
string<date-time>

Filter certificates by validity start date (less than or equal <=)

validFrom[strictly_before]
string<date-time>

Filter certificates by validity start date (less than <)

validFrom[after]
string<date-time>

Filter certificates by validity start date (greater than or equal >=)

validFrom[strictly_after]
string<date-time>

Filter certificates by validity start date (greater than >)

validTo[before]
string<date-time>

Filter certificates by validity end date (less than or equal <=)

validTo[strictly_before]
string<date-time>

Filter certificates by validity end date (less than <)

validTo[after]
string<date-time>

Filter certificates by validity end date (greater than or equal >=)

validTo[strictly_after]
string<date-time>

Filter certificates by validity end date (greater than >)

order[validFrom]
enum<string>

Order certificates by validity start date

Available options:
asc,
desc
Example:

"asc"

order[validTo]
enum<string>

Order certificates by validity end date

Available options:
asc,
desc
Example:

"asc"

serialNumber
string

Filter certificates by serial number (supports partial matching)

type
enum<string>

Filter certificates by type

Available options:
efirma,
csd

Response

SAT Certificates

@context
string
default:/contexts/SatCertificate
@id
string
Example:

"/entities/91ab5678-1234-5678-9abc-def012345678/datasources/mx/sat/certificados"

@type
string
default:hydra:Collection
hydra:member
object[]
hydra:totalItems
integer

Total number of items found

Required range: x >= 0
Example:

1

hydra:view
object

Pagination information