Skip to main content
POST
/
api
/
v1
/
oauth
/
initiate
Initiate Oauth
curl --request POST \
  --url https://api.example.com/api/v1/oauth/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "<string>",
  "auth_method_id": "oauth2",
  "scopes": [
    "<string>"
  ],
  "redirect_uri": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id
string | null

The workspace ID

Body

application/json

Request to initiate OAuth flow.

integration_id
string
required
auth_method_id
string
default:oauth2
scopes
string[] | null
redirect_uri
string | null

Response

Successful Response