Default

Migrate

get

Responses

200

Successful Response

application/json

Responseany

get

/migrate-tokens

HTTPcURLJavaScriptPython

GET /migrate-tokens HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Deprecated

Create Client

post

Create a new client.

Args: request (CreateClientRequest): The request body containing client information.

Returns: ApiResponse: The API response containing the created client info.

Body

application/json

Create client request model.

namestringRequired

can_get_integrationsany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/create-client

HTTPcURLJavaScriptPython

POST /create-client HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "name": "text",
  "can_get_integrations": false
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "api_key": "text",
    "is_active": true,
    "can_get_integrations": false
  },
  "meta": null
}

Get Client List

get

Get a list of all clients.

Returns: ApiResponse: The API response containing the list of clients.

Responses

200

Successful Response

application/json

get

/clients

HTTPcURLJavaScriptPython

GET /clients HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "api_key": "text",
      "is_active": true,
      "can_get_integrations": false
    }
  ],
  "meta": null
}

Create Client

post

Create a new client.

Args: request (CreateClientRequest): The request body containing client information.

Returns: ApiResponse: The API response containing the created client info.

Body

application/json

Create client request model.

namestringRequired

can_get_integrationsany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/clients

HTTPcURLJavaScriptPython

POST /clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "name": "text",
  "can_get_integrations": false
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "api_key": "text",
    "is_active": true,
    "can_get_integrations": false
  },
  "meta": null
}

Update Client

patch

update client.

Args: request (CreateClientRequest): The request body containing client information.

Returns: ApiResponse: The API response containing the created client info.

Body

application/json

Update client request model.

x_api_keystringRequired

nameany ofOptional

stringOptional

or

nullOptional

can_get_integrationsany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

patch

/clients

HTTPcURLJavaScriptPython

PATCH /clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "x_api_key": "text",
  "name": "text",
  "can_get_integrations": true
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "api_key": "text",
    "is_active": true,
    "can_get_integrations": false
  },
  "meta": null
}

Deprecated

Register User For Client

post

Register a new user for the client.

Args: request (RegisterUserRequest): The request body containing user information. x_api_key (str): The API key from the header.

Returns: ApiResponse: The API response containing the registered user info.

Header parameters

x-api-keystringRequired

Body

application/json

Register user request model.

identifierstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/clients/register-user

HTTPcURLJavaScriptPython

POST /clients/register-user HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "identifier": "text"
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "123e4567-e89b-12d3-a456-426614174000",
    "identifier": "text",
    "secret": "text",
    "secret_preview": "text",
    "is_active": true,
    "integrations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "connector": "text",
        "user_identifier": "text",
        "selected": true
      }
    ]
  },
  "meta": null
}

Register User For Client

post

Register a new user for the client.

Args: request (RegisterUserRequest): The request body containing user information. x_api_key (str): The API key from the header.

Returns: ApiResponse: The API response containing the registered user info.

Header parameters

x-api-keystringRequired

Body

application/json

Register user request model.

identifierstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/users

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "identifier": "text"
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "123e4567-e89b-12d3-a456-426614174000",
    "identifier": "text",
    "secret": "text",
    "secret_preview": "text",
    "is_active": true,
    "integrations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "connector": "text",
        "user_identifier": "text",
        "selected": true
      }
    ]
  },
  "meta": null
}

Deprecated

Login User For Client

post

Log in a user for a client and return an access token.

Args: x_api_key (str): The API key from the header. form_data (LoginUserRequest): The login credentials.

Returns: ApiResponse: The API response containing the token info.

Header parameters

x-api-keystringRequired

Body

application/json

Login user request model.

identifierstringRequired

secretstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/clients/oauth-token

HTTPcURLJavaScriptPython

POST /clients/oauth-token HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "identifier": "text",
  "secret": "text"
}

{
  "data": {
    "token": "text",
    "token_type": "text",
    "expires_at": "text",
    "is_revoked": true,
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "meta": null
}

Deprecated

Logout User For Client

delete

Log out a user by revoking their access token.

Args: x_api_key (str): The API key from the header. authorization (str): The Authorization header containing the Bearer token.

Returns: ApiResponse: The API response indicating success.

Header parameters

x-api-keystringRequired

authorizationstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

delete

/clients/oauth-token

HTTPcURLJavaScriptPython

DELETE /clients/oauth-token HTTP/1.1
Host: 
x-api-key: text
authorization: text
Accept: */*

{
  "data": true,
  "meta": null
}

Login User For Client

post

Log in a user for a client and return an access token.

Args: x_api_key (str): The API key from the header. form_data (LoginUserRequest): The login credentials.

Returns: ApiResponse: The API response containing the token info.

Header parameters

x-api-keystringRequired

Body

application/json

Login user request model.

identifierstringRequired

secretstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/auth/tokens

HTTPcURLJavaScriptPython

POST /auth/tokens HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "identifier": "text",
  "secret": "text"
}

{
  "data": {
    "token": "text",
    "token_type": "text",
    "expires_at": "text",
    "is_revoked": true,
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "meta": null
}

Logout User For Client

delete

Log out a user by revoking their access token.

Args: x_api_key (str): The API key from the header. authorization (str): The Authorization header containing the Bearer token.

Returns: ApiResponse: The API response indicating success.

Header parameters

x-api-keystringRequired

authorizationstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

delete

/auth/tokens

HTTPcURLJavaScriptPython

DELETE /auth/tokens HTTP/1.1
Host: 
x-api-key: text
authorization: text
Accept: */*

{
  "data": true,
  "meta": null
}

Deprecated

Get Logged In User

get

Get the currently logged-in user's information.

Args: x_api_key (str): The API key from the header. authorization (str): The Authorization header containing the Bearer token. connectors (str, optional): Filter integrations by connector names. Supports single connector (e.g., 'microsoft_sharepoint') or multiple comma-separated connectors (e.g., 'microsoft_sharepoint,google_docs'). All provided connector names must be valid plugin names, otherwise an HTTP 400 error will be returned. Defaults to None.

Returns: ApiResponse: The API response containing user info with optionally filtered integrations.

Raises: HTTPException: When connectors parameter contains invalid connector names (status_code=400).

Query parameters

connectorsany ofOptional

stringOptional

or

nullOptional

Header parameters

x-api-keystringRequired

authorizationstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/clients/user

HTTPcURLJavaScriptPython

GET /clients/user HTTP/1.1
Host: 
x-api-key: text
authorization: text
Accept: */*

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "123e4567-e89b-12d3-a456-426614174000",
    "identifier": "text",
    "secret": "text",
    "secret_preview": "text",
    "is_active": true,
    "integrations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "connector": "text",
        "user_identifier": "text",
        "selected": true
      }
    ]
  },
  "meta": null
}

Get Logged In User

get

Get the currently logged-in user's information.

Args: x_api_key (str): The API key from the header. authorization (str): The Authorization header containing the Bearer token. connectors (str, optional): Filter integrations by connector names. Supports single connector (e.g., 'microsoft_sharepoint') or multiple comma-separated connectors (e.g., 'microsoft_sharepoint,google_docs'). All provided connector names must be valid plugin names, otherwise an HTTP 400 error will be returned. Defaults to None.

Returns: ApiResponse: The API response containing user info with optionally filtered integrations.

Raises: HTTPException: When connectors parameter contains invalid connector names (status_code=400).

Query parameters

connectorsany ofOptional

stringOptional

or

nullOptional

Header parameters

x-api-keystringRequired

authorizationstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/users/me

HTTPcURLJavaScriptPython

GET /users/me HTTP/1.1
Host: 
x-api-key: text
authorization: text
Accept: */*

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "123e4567-e89b-12d3-a456-426614174000",
    "identifier": "text",
    "secret": "text",
    "secret_preview": "text",
    "is_active": true,
    "integrations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "connector": "text",
        "user_identifier": "text",
        "selected": true
      }
    ]
  },
  "meta": null
}