---
title: "Get Endpoint Oauth Config"
method: GET
path: "/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth"
tags: ["Endpoint"]
---

# Get Endpoint Oauth Config

`GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth`

## Request

- Base URL: `https://api.eu.svix.com`
- URL: `https://api.eu.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/svix/apis/svix-api/docs/api/v1/app/:app_id/endpoint/:endpoint_id/oauth/get.ts> (a function with typed inputs; its response is checked against the schema)

Get endpoint OAuth status and configuration.

Returns a 200 with `enabled: false` and `config: null` when OAuth is not enabled.

## Path parameters

- `app_id` string, required: The Application's ID or UID.
- `endpoint_id` string, required: The Endpoint's ID or UID.

## Response `200`

- EndpointOauthOut
  - `config` EndpointOauthConfigOut
    - `authMethod` 'clientSecretJwt' | 'clientSecretBasic' | 'clientSecretPost', required: The method used for authenticating to the OAuth authorization server. `clientSecretJwt` will construct a JWT used for authentication with the oauth authorization server. This method is less commonly used and may not be supported by all oauth providers. `clientSecretBasic` will authenticate to the oauth authorization server using an `Authorization` header with the client secret as the value. This is the most common means of authentication. `clientSecretPost` will authenticate to the oauth authorization server by passing the client secret in a `client_secret` field in the request body. This method may not be supported by all oauth providers, and in general `clientSecretBasic` should be preferred.
    - `clientId` string, required
    - `extraHeaders` object, nullable
    - `extraParams` object, nullable
    - `grantType` 'clientCredentials' | 'refreshToken', required
    - `scopes` string[], nullable
    - `tokenUrl` string, required
  - `enabled` boolean, required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `422`: Validation Error
- `429`: Too Many Requests

## Changes

- **2026-11-09** `f2cb264ac18a`: 1 info
  - endpoint added
- **2026-08-19** `dc130bd1b074`: 1 breaking
  - api path removed without deprecation
- **2026-07-31** `16dbcc056c48`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/svix/apis/svix-api/changes/api/v1/app/:app_id/endpoint/:endpoint_id/oauth/get.md)

---

[API](https://skmtc.dev/svix/apis/svix-api.md) - [All operations](https://skmtc.dev/svix/apis/svix-api/llms.txt) - [OpenAPI document](https://skmtc.dev/svix/apis/svix-api/revisions/f2cb264ac18a?raw)