SUsurense
Reports

Get a report record

Retrieve a specific report record by its UUID.

get/reports/{id}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/reports/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Path parameters

idstring uuid required

Report record ID

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid

Report record ID

providerstring uuid

ID of the report provider the record was generated with

paramsobject

The params the report was requested with

status'INITIATED' | 'PROCESSING' | 'PROCESSED' | 'FAILED'

Generation status of the report

startedAtstring date-time

When the generation started

endedAtstring date-time

When the generation ended

fileNamestring

File name of the generated report

downloadableboolean

Whether the report is ready and still within its download window

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "2899ca29-8672-4a12-96f3-7147a09716cd",
  "fileName": "דוח_ימי_הולדת_21-10-2026_10-00-00.xlsx"
}

Changes

No recorded changes to this operation across all 1 revision of this API.