SUsurense
Employers

Get export record

Export employers in a 3-stage process:

(1) Filter and choose which employers to export using POST /employers/exports - works like POST /employers/search with filtering, returns the UUID of the export record.

(2) Check export status using GET /employers/exports/{id} - status can be INITIATED, PROCESSING, PROCESSED, or FAILED.

(3) Download the file using POST /employers/exports/{id}/download - returns the URL of the file in the url field that can be fetched using a simple HTTP GET request.

This is Stage 2 of 3: Check export status.

get/employers/exports/{id}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/employers/exports/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: global:export

Path parameters

idstring uuid required

Export record UUID

Response

OK

idstring uuid
tenantIdstring uuid
agencyIdstring uuid
providerIdstring
status'INITIATED' | 'PROCESSING' | 'PROCESSED' | 'FAILED'
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
startedAtstring date-time
endedAtstring date-time
fileNamestring
fileMimestring
downloadableboolean

Changes

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