Get Integration

GET

/org/:org_id/project/:project_id/integration/:integration_id

GET

/api/v1/org/:org_id/project/:project_id/integration/:integration_id

$ curl https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/integration/integration_id \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "string",
3   "project_id": "string",
4   "type": "google_sheets",
5   "name": "string",
6   "auth_type": "oauth_project_default",
7   "created": "string",
8   "modified": "string",
9   "config": {},
10   "tools": [
11     {
12       "id": "string",
13       "name": "string",
14       "tool_name": "string",
15       "safe_tool_name": "string",
16       "enabled": true,
17       "created": "string",
18       "modified": "string",
19       "description": "string",
20       "tool_description": "string",
21       "tool_input_schema": {}
22     }
23   ],
24   "setup_instructions": "string"
25 }

Retrieve a project integration, including persisted tools and setup guidance.

Authentication

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

Path parameters

integration_idstringRequiredformat: "uuid"

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

Response

Integration retrieved

idstringformat: "uuid"

project_idstringformat: "uuid"

typeenum

namestring

auth_typeenum

createdstring

modifiedstring

configmap from strings to any or null

toolslist of objects

setup_instructionsstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error