Skip to main content
GET
/
v1
/
oauth-apps
List OAuth apps
curl --request GET \
  --url https://api.sequin.io/v1/oauth-apps \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "provider": "stripe",
      "name": "My Stripe OAuth App",
      "client_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "client_secret": "**********",
      "metadata": { "custom_property": 42 },
      // the health field is coming soon
      "health": {
        "status": "ok",
        "notes": [],
        "time": "2023-12-15 01:29:29"
      },
      "created_at": "2024-02-20T02:10:52Z",
      "updated_at": "2024-02-20T02:10:52Z"
    },
    { ... },
    { ... }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://sequin.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Request parameters

Request parameters are coming soon.
​
provider
string
Filter for OAuth apps for this provider (e.g. github, stripe, etc). See the list of possible values.
​
health.status
string
Filter for OAuth apps with this health status (e.g. ok, error, etc). See the list of possible OAuth app health.status values.
​
truncate_secrets
boolean
default:"true"
Determines whether the response contains truncated or full secrets.
​
metadata
json
Filter for OAuth apps matching the properties supplied in this map. For example, {"custom_property": 42} will return all OAuth apps with a custom_property of 42.

​
Response fields

{
  "data": [
    {
      "id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "provider": "stripe",
      "name": "My Stripe OAuth App",
      "client_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "client_secret": "**********",
      "metadata": { "custom_property": 42 },
      // the health field is coming soon
      "health": {
        "status": "ok",
        "notes": [],
        "time": "2023-12-15 01:29:29"
      },
      "created_at": "2024-02-20T02:10:52Z",
      "updated_at": "2024-02-20T02:10:52Z"
    },
    { ... },
    { ... }
  ]
}
​
id
string
ID of the OAuth app.
​
name
string
Display name of the OAuth app.
​
health
object
Status of the OAuth app. Learn more about the health object.
​
provider
string
The provider of the OAuth app. See a list of supported providers here.
​
client_id
string
The client ID of the OAuth app.
​
client_secret
string
The client secret of the OAuth app.
​
metadata
object
Metadata for the OAuth app. This is a free-form object that you can use to store any additional information you want to associate with the OAuth app.
​
created_at
string
Timestamp of when the OAuth app was created, in ISO 8601 format.
​
updated_at
string
Timestamp of when the OAuth app was last updated, in ISO 8601 format.