Sign in
Installations

Install your app on a company or syndicate

Changed on

Installs the calling application on a company or syndicate the token's user can edit (or, for a syndicate, manages), and mints the company-owned token the install stands for. The token appears in this response only. Requires a token authorized by a user.

The install is granted at the caller's tier (founder, admin or editor for a company). An editor-tier install carries read scopes only; write scopes in scopes are dropped. Installing on a company outside your own organization requires the app to be approved.

post/installations

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/installations
  • Auth: OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: write:installations)

Request body

target_type'company' | 'syndicate' required
target_idstring required

The company (co_…) or syndicate (syn_…) external id.

scopesstring[]

Subset of the app's declared scopes to grant. Defaults to all of them.

tierstring

Optional higher tier (founder / full_access), honored only when the caller holds it.

Response

The new installation and its token (shown once)

metaobject

Example response

{
  "data": {
    "type": "installation"
  },
  "token": {
    "access_token": "at_live_…",
    "token_type": "Bearer"
  }
}

Changes