List credentials

curl --request GET \
  --url https://api.sequin.io/v1/credentials \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequin.io/v1/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequin.io/v1/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequin.io/v1/credentials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequin.io/v1/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
      "provider": "stripe",
      "oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "oauth_app": {
        "name": "Arakkis - Stripe",
        "id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8"
        "client_id": "b9f074c939140210e8c231845bbe8b98",
        "client_secret": "**********",
        "metadata": {},
        "provider": "stripe",
        "created_at": "2024-02-20T02:10:52Z",
        "updated_at": "2024-02-20T02:10:52Z"

      },
      "properties": {
        "kind": "stripe_key",
        "name": "TEST ACCOUNT",
        "secret": "***********",
        "test": true
      },
      "metadata": { "custom_property": 42 },
      // The health field is coming soon
      "health": {
        "status": "error",
        "notes": [
          "We're receiving 401s from Stripe for this token. That usually means the token is expired or revoked. We've emailed the owner of this credential to let them know."
        ],
        "time": "2023-12-15 01:29:29"
      },
      "created_at": "2024-02-19T22:59:41Z",
      "updated_at": "2024-02-19T22:59:41Z"
    },
    { ... },
    { ... }
  ]
}

GET

credentials

List credentials

curl --request GET \
  --url https://api.sequin.io/v1/credentials \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequin.io/v1/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequin.io/v1/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequin.io/v1/credentials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequin.io/v1/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
      "provider": "stripe",
      "oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "oauth_app": {
        "name": "Arakkis - Stripe",
        "id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8"
        "client_id": "b9f074c939140210e8c231845bbe8b98",
        "client_secret": "**********",
        "metadata": {},
        "provider": "stripe",
        "created_at": "2024-02-20T02:10:52Z",
        "updated_at": "2024-02-20T02:10:52Z"

      },
      "properties": {
        "kind": "stripe_key",
        "name": "TEST ACCOUNT",
        "secret": "***********",
        "test": true
      },
      "metadata": { "custom_property": 42 },
      // The health field is coming soon
      "health": {
        "status": "error",
        "notes": [
          "We're receiving 401s from Stripe for this token. That usually means the token is expired or revoked. We've emailed the owner of this credential to let them know."
        ],
        "time": "2023-12-15 01:29:29"
      },
      "created_at": "2024-02-19T22:59:41Z",
      "updated_at": "2024-02-19T22:59:41Z"
    },
    { ... },
    { ... }
  ]
}

Request parameters

Request parameters are coming soon.

string

Filter for credentials for this provider (e.g. github, stripe, etc). See the list of possible values.

string

Kind of credential (e.g. stripe_oauth2, stripe_sequin, etc). See the list of possible values.

string

Filter for credentials with this health status (e.g. ok, error, etc). See the list of possible credential health.status values.

json

Filter for credentials matching the properties supplied in this map. For example, {"custom_property": 42} will return all credentials with a custom_property of 42.

Response fields

{
  "data": [
    {
      "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
      "provider": "stripe",
      "oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "oauth_app": {
        "name": "Arakkis - Stripe",
        "id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8"
        "client_id": "b9f074c939140210e8c231845bbe8b98",
        "client_secret": "**********",
        "metadata": {},
        "provider": "stripe",
        "created_at": "2024-02-20T02:10:52Z",
        "updated_at": "2024-02-20T02:10:52Z"

      },
      "properties": {
        "kind": "stripe_key",
        "name": "TEST ACCOUNT",
        "secret": "***********",
        "test": true
      },
      "metadata": { "custom_property": 42 },
      // The health field is coming soon
      "health": {
        "status": "error",
        "notes": [
          "We're receiving 401s from Stripe for this token. That usually means the token is expired or revoked. We've emailed the owner of this credential to let them know."
        ],
        "time": "2023-12-15 01:29:29"
      },
      "created_at": "2024-02-19T22:59:41Z",
      "updated_at": "2024-02-19T22:59:41Z"
    },
    { ... },
    { ... }
  ]
}

string

ID of the credential.

string

Provider of the credential (e.g. github, stripe, etc). See the list of possible values.

string

Kind of credential (e.g. stripe_oauth, github, etc). See the list of possible values.

object

Status of the credential. Learn more about the health object.

object

OAuth app associated to the credential. Learn more about the OAuth app object.

credential_properties

The properties for the credential. This field is polymorphic based on the credential kind. Learn more about credential properties.

string

Metadata for the credential. This is a free-form object that you can use to store any additional information you want to associate with the credential.

string

Timestamp of when the credential was created, in ISO 8601 format.

string

Timestamp of when the credential was last updated, in ISO 8601 format.

​Request parameters

​Response fields

Request parameters

Response fields