ProspectsRead a file

Read a file

Needs: Prospects, Read

Reads an uploaded prospect file: text, CSV, JSON or XML (up to 30000 characters), or a PDF or image (PNG, JPEG, GIF or WebP). The file must belong to the prospect, and be up to 2 MB. An attached form is read with the form submission endpoint instead.

Note: A PDF or image comes back as a file object with filename, mediaType and a base64 url, and in the REST response it also appears under content. A file over 2 MB or of another type returns an error.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/prospects/123/files/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": {
    "id": 6,
    "name": "Notes",
    "filename": "notes.txt",
    "mime_type": "text/plain",
    "size": 120
  },
  "text": "Enquiry notes...",
  "truncated": false
}
GET
/prospects/{prospect_id}/files/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
path
idinteger
Required

The file id from the files list.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Path Parameters

idinteger
Required

The file id from the files list.

Responses

Text file