Skip to main content
POST
/
google-drive
/
v1
/
async
/
list-files
List Google Drive content asynchronously
curl --request POST \
  --url https://eu.phrase.com/connectors/google-drive/v1/async/list-files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Webhook: <x-webhook>' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {},
  "path": {
    "pathType": "ROOT"
  }
}
'
{
  "requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
  "webHookUrl": "https://example.tld/my-webhook"
}

Authorizations

​
Authorization
string
header
required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

​
X-ActionId
string

A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.

​
X-ResponseType
string

Specify if the response should contain the processed object itself in an application/octet-stream body, or a application/json body with an ID that can be then used to retrieve the object using a /load-content endpoint. Note that for larger files (> 1 MB), it is advised to use the ID option which is also default.

​
X-Webhook
string
required

Required on /async/... endpoints. Bifrost POSTs the operation result to this URL once the connector finishes processing. Omitting this header on an async endpoint returns 400.

Body

application/json

Request payload for listing folders and files in Google Drive.

The path determines where the listing starts (for example, connector root, a shared drive, or a specific folder). Authentication is provided via connectorUuid.

​
connectorUuid
string
required

UUID of a configured connector that holds stored Google Drive credentials.

Example:

"b9c06f76-4a44-4d2e-8a26-3d1e4b47e123"

​
configuration
object
required

Connector configuration for the Google Drive connector.

Currently no configuration options are exposed. The object is reserved for future configuration flags while keeping the API contract stable.

Example:
{}
​
path
object

Polymorphic description of a Google Drive location used by connector operations.

The pathType discriminator selects the concrete shape:

  • ROOT - connector entry listing available spaces
  • SHARED_DRIVES_ROOT - virtual root listing shared drives
  • FOLDER - real folder or drive root
  • FILE - real file under a folder
​
locale
string

Locale code used for localization-aware behaviors, if any. Optional. Use a BCP 47 or Phrase locale code (for example, "en", "de", "cs").

Example:

"en"

Response

Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.

​
webhookUrl
string

Webhook URL you supplied in the request

​
requestId
string

Request ID you can use to retrieve the result