Sources

API endpoints for discovering available data source connectors and their configuration requirements

List

get
/sources

List all available data source connectors.

Returns the complete catalog of source types that Graffo can connect to.

Authorizations
x-api-keystringRequired

Organization API key for authentication

Header parameters
X-Organization-IDany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/sources
GET /sources HTTP/1.1
Host: api.graffo.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "GitHub",
    "description": "Connect to GitHub repositories for code, issues, pull requests, and documentation",
    "auth_type": "config_class",
    "auth_config_class": "GitHubAuthConfig",
    "config_class": "GitHubConfig",
    "short_name": "github",
    "class_name": "GitHubSource",
    "output_entity_definition_ids": [
      "def12345-6789-abcd-ef01-234567890abc",
      "def67890-abcd-ef01-2345-67890abcdef1"
    ],
    "labels": [
      "code"
    ],
    "created_at": "2024-01-01T00:00:00Z",
    "modified_at": "2024-01-01T00:00:00Z",
    "auth_fields": {
      "fields": [
        {
          "name": "personal_access_token",
          "title": "Personal Access Token",
          "description": "GitHub Personal Access Token with repository read permissions",
          "type": "string",
          "secret": true
        },
        {
          "name": "repo_name",
          "title": "Repository Name",
          "description": "Full repository name in format 'owner/repo'",
          "type": "string"
        }
      ]
    }
  }
]

Get

get
/sources/{short_name}

Get detailed information about a specific data source connector.

Authorizations
x-api-keystringRequired

Organization API key for authentication

Path parameters
short_namestringRequired

Technical identifier of the source type (e.g., 'github', 'stripe', 'slack')

Header parameters
X-Organization-IDany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/sources/{short_name}
GET /sources/{short_name} HTTP/1.1
Host: api.graffo.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "GitHub",
  "description": "Connect to GitHub repositories for code, issues, pull requests, and documentation",
  "auth_type": "config_class",
  "auth_config_class": "GitHubAuthConfig",
  "config_class": "GitHubConfig",
  "short_name": "github",
  "class_name": "GitHubSource",
  "output_entity_definition_ids": [
    "def12345-6789-abcd-ef01-234567890abc",
    "def67890-abcd-ef01-2345-67890abcdef1"
  ],
  "labels": [
    "code"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "modified_at": "2024-01-01T00:00:00Z",
  "auth_fields": {
    "fields": [
      {
        "name": "personal_access_token",
        "title": "Personal Access Token",
        "description": "GitHub Personal Access Token with repository read permissions",
        "type": "string",
        "secret": true
      },
      {
        "name": "repo_name",
        "title": "Repository Name",
        "description": "Full repository name in format 'owner/repo'",
        "type": "string"
      }
    ]
  }
}
PreviousSource Connections

Last updated