Organizations API Documentation

How to integrate and validate Skyverns API

Get Organizations

Retrieves the organization information for the current authenticated user.

Endpoint

GET https://api.skyvern.com/api/v1/organizations

Authentication

This endpoint requires Bearer Token authentication. Include the token in the x-api-key header of your request.

x-api-key: <your_api_key_here>

Response

Successful Response (200 OK)

The API will return a JSON object containing an array of organizations associated with the authenticated user.

1{
2 "organizations": [
3 {
4 "organization_id": "uuid-string",
5 "organization_name": "Organization Name"
6 }
7 ]
8}
  • organizations: An array of organization objects
    • organization_id: A unique identifier for the organization (UUID format)
    • organization_name: The name of the organization

Error Responses

  • 401 Unauthorized: The request lacks valid authentication credentials
  • 403 Forbidden: The authenticated user does not have permission to access the requested resource
  • 500 Internal Server Error: An unexpected error occurred on the server

Example Request

Using cURL:

$curl -X GET "https://api.skyvern.com/api/v1/organizations" \
> -H "x-api-key: your_api_key_here"

Using Python with the requests library:

1import requests
2
3url = "https://api.skyvern.com/api/v1/organizations"
4headers = {
5 "x-api-key": "your_api_key"
6}
7
8response = requests.get(url, headers=headers)
9
10if response.status_code == 200:
11 organizations = response.json()["organizations"]
12 for org in organizations:
13 print(f"Organization ID: {org['organization_id']}")
14 print(f"Organization Name: {org['organization_name']}")
15else:
16 print(f"Error: {response.status_code}")
17 print(response.text)

Remember to replace your_api_key with your API Key token retrieved from Skyvern’s setting page