Skip to main content
GET
/
v1
/
auth
/
status
Get Auth Status
curl --request GET \
  --url https://api.retab.com/v1/auth/status \
  --header 'Api-Key: <api-key>'
{
  "auth_method": "<string>",
  "authenticated": true,
  "environment": {
    "id": "<string>",
    "name": "<string>"
  },
  "key": {
    "prefix": "<string>",
    "name": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

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

Return the caller’s resolved organization and environment context.
Python
from retab import Retab

client = Retab()

status = client.auth.list_status()
print(status.auth_method)
TypeScript
import { Retab } from "@retab/node";

const client = new Retab({ apiKey: process.env.RETAB_API_KEY });

const status = await client.auth.list_status();
console.log(status.authMethod);
Go
package main

import (
	"context"
	"fmt"
	"log"

	retab "github.com/retab-dev/retab/clients/go"
)

func main() {
	client, err := retab.NewClient("")
	if err != nil {
		log.Fatal(err)
	}

	status, err := client.Auth.ListStatus(context.Background())
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(status.AuthMethod)
}
Java
import com.retab.RetabClient;

public final class Example {
  public static void main(String[] args) throws Exception {
    RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));

    var status = client.auth().listStatus();
    System.out.println(status.getAuthMethod());
  }
}
cURL
curl -X GET 'https://api.retab.com/v1/auth/status' \
  -H "Api-Key: $RETAB_API_KEY"

Authorizations

​
Api-Key
string
header
required

Response

Successful Response

​
auth_method
string
required
​
authenticated
boolean
default:true
​
environment
AuthStatusEnvironment · object
​
key
AuthStatusKey · object