API reference · Files

Get a file

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

Retrieve information about a file generation request.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

fileGenerationRequestId#stringin pathrequired

Response

200 · FileGenerationRequest

No field is described in the spec.

fileGenerationRequestId#stringalways returned
hash#stringalways returned
slug#stringalways returned
type#FileGenerationTypealways returned
ZIPPRINT_PHYSICAL_CARDS_PDF
status#FileGenerationStatusalways returned
PENDINGDONEFAILED
accountId#string
userId#string
charityId#string
charityUserId#string
createdAt#string (date-time)always returned
updatedAt#string (date-time)always returned

Errors

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

403Account closed

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

404Not Found

{
  "statusCode": 404,
  "message": "Not Found"
}

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

1curl -X GET https://api.sandbox.charitips.com/v1/files/file-generation-requests/<fileGenerationRequestId> \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.