SHshipsecai
integrations

POST /api/v1/integrations/{provider}/exchange

Changed on

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/integrations/{provider}/exchange
  • Auth
    none declared

Path parameters

providerstring required

Request body

userIdstring required

Application user identifier to associate the connection with

redirectUristring required

Frontend callback URL that receives the OAuth code

scopesstring[]

Optional override of scopes to request

statestring required

Opaque OAuth state returned from the authorize redirect

codestring required

Authorization code issued by the provider

Response

idstring required
providerstring required
providerNamestring required
userIdstring required
scopesstring[] required
tokenTypestring required
expiresAtstring
createdAtstring required
updatedAtstring required
status'active' | 'expired' required
supportsRefreshboolean required
hasRefreshTokenboolean required
metadataobject

Provider-specific metadata saved alongside the connection

Changes