Skip to main content
POST
Call a connected app's API directly

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

Unified public connection id, as returned by GET /connections/connected. Opaque — pass it back verbatim.

Body

application/json
endpoint
string
required

Path relative to the app's API base URL (e.g. /gmail/v1/users/me/messages), or an absolute URL on the app's own domain.

method
enum<string>
default:GET
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
body

Request body, sent verbatim. Ignored for GET.

headers
object

Extra headers forwarded to the app. Authorization and other transport headers are ignored.

Response

The app's response, verbatim

object
enum<string>
required
Available options:
connection_proxy_response
connection
string
required

The connection public id

status
integer
required

The status code the app returned

endpoint
string | null
truncated
boolean

The response body exceeded the size cap and was cut

body

The app's response body