List API keys for a service account

curl --request GET \
  --url https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys', 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://flows.super.ai/api/service-accounts/{service_account_id}/api-keys",
  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>",
    "X-API-Key: <api-key>"
  ],
]);

$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://flows.super.ai/api/service-accounts/{service_account_id}/api-keys"

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "name": "API Key",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "token_prefix": "saf_org_550e8400_abc123",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "API key for external integrations",
    "service_account_id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000"
  }
]

service-accounts

List API keys for a service account

List all API keys associated with a specific service account.

Returns all API keys that belong to the specified service account. The user must have access to the service account to view its API keys.

Context:

Only returns API keys for the specified service account
User must have access to the service account
Returns empty list if no API keys exist for the account

Related Endpoints:

GET /service-accounts/ - Get service account details
POST /api-keys - Create a new API key

GET

api

service-accounts

{service_account_id}

api-keys

List API keys for a service account

curl --request GET \
  --url https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys', 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://flows.super.ai/api/service-accounts/{service_account_id}/api-keys",
  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>",
    "X-API-Key: <api-key>"
  ],
]);

$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://flows.super.ai/api/service-accounts/{service_account_id}/api-keys"

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/service-accounts/{service_account_id}/api-keys")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "name": "API Key",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "token_prefix": "saf_org_550e8400_abc123",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "API key for external integrations",
    "service_account_id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000"
  }
]

Authorizations

X-API-Key

string

header

required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

X-API-Key: saf_1234567890

Authorization

string

header

required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Path Parameters

service_account_id

string<uuid>

required

UUID of the service account to list API keys for

Query Parameters

offset

integer

default:0

Number of records to skip for pagination

Required range: x >= 0

limit

integer

default:100

Maximum number of records to return

Required range: 1 <= x <= 1000

Response

List of API keys retrieved successfully

created_at

string<date-time>

required

string<uuid>

required

modified_by

string

required

name

string

required

Human-readable name for this API key.

Maximum string length: 255

Example:

"API Key"

organization_id

string<uuid>

required

UUID of the organization this API key belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

token_prefix

string

required

Prefix of the authentication token for display purposes. Full token is only shown once during creation.

Maximum string length: 40

Example:

"saf_org_550e8400_abc123"

updated_at

string<date-time>

required

description

string | null

Optional description explaining the purpose and usage of this API key.

Example:

"API key for external integrations"

service_account_id

string<uuid> | null

UUID of the service account this API key belongs to. NULL for user keys.

Example:

"550e8400-e29b-41d4-a716-446655440000"

user_id

string<uuid> | null

UUID of the user this API key belongs to. NULL for service account keys.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Activate a service account Create an API key for a service account