---
title: "Start an app listing OAuth install"
method: POST
path: "/app-listings/install/"
tags: ["app-listings"]
---

# Start an app listing OAuth install

`POST /app-listings/install/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/app-listings/install/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Return the provider OAuth authorize URL for connecting an app listing.

## Request body

- AppListingInstallRequestSchema: Request to begin an app listing OAuth install.
  - `inputs` object: Connect-time inputs collected before the redirect (tenant address, region, or a choice), keyed by input name. Empty for listings that need no inputs.
  - `integration_id` string, uuid, nullable: For switch/reconnect only: the existing integration to re-authorize in place. Bound into the OAuth state so the claim mutates only this integration. Omit for new connects.
  - `intent` 'switch' | 'reconnect': Why an OAuth grant is being captured against an *existing* integration. Set on an installation whose grant re-authorizes a connection in place rather than creating a new one. ``None`` on a normal new-connect install.
  - `slug` string, required

## Response `200`

Successful Response

- AppListingInstallResponseSchema: The provider authorize URL to redirect the user to.
  - `authorize_url` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: App listing not found
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)