API reference · Files

Generate a file generation request download url

GET/v1/files/file-generation-requests/{fileGenerationRequestId}/download-url

Generate a url that can be used to download the given file.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

fileGenerationRequestId#stringin pathrequired

Response

200 · DownloadUrl

No field is described in the spec.

filename#stringalways returned
downloadUrl#stringalways returned

Errors

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

403Account closed

{
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}

403Forbidden
Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.
```
{
  "statusCode": 403,
  "message": "Forbidden"
}
```
404Not Found
No resource with this id on your account: the API answers as if it did not exist.
```
{
  "statusCode": 404,
  "message": "Not Found"
}
```

GET /v1/files/file-generation-requests/<fileGenerationRequestId>/download-url

1curl -X GET https://api.sandbox.charitips.com/v1/files/file-generation-requests/<fileGenerationRequestId>/download-url \2  -H "Authorization: Bearer $CHARITIPS_TOKEN"

Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.