Retrieve XLSX Export File of Records
Changed onExport a records report with filtering available via query parameters.
OAuth Scope required: public.records.readRecords
Request
- Base URLhttps://ironcladapp.com/public/api/v1
- URLhttps://ironcladapp.com/public/api/v1/records/export
- AuthAPI key in header Authorization and OAuth 2Authorization code: https://ironcladapp.com/oauth/authorizeClient credentialsToken URL: https://ironcladapp.com/oauth/token scopes: public.records.readRecords
Query parameters
Comma separated list of record types to export. Example: mutualNDA,NDA
IDs of properties to export, comma separated. Example: counterpartyName,agreementDate
Headers
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.
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
200
Changes
- breaking
the
queryrequest parameterpropertiesbecame required - breaking
the
queryrequest parametertypesbecame required
- breaking