IRironcladapp
Records

Get Records Export Status

Changed on

Poll the status of a previously created async records export. When the export is complete, the response includes a signed downloadUrl (valid for 15 minutes; see expiresAt) to stream the file directly. The export is scoped to the user who created it.

OAuth Scope required: public.records.readRecords

get/records/exports/{exportId}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/records/exports/{exportId}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.records.readRecords

Path parameters

exportIdstring uuid required

The export identifier.

Example:b3f1c2a4-5d6e-7f80-91a2-b3c4d5e6f708

The export ID returned from the create records export endpoint.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

The current status of the export.

OR
OR

Example response

{
  "exportId": "b3f1c2a4-5d6e-7f80-91a2-b3c4d5e6f708",
  "status": "processing"
}

Changes