Wexa AI
  1. Connectors
Wexa AI
  • Wexa AI
  • Getting Started with Wexa AI
  • Use Cases and Workflows
  • API Reference
  • Tutorials
  • Troubleshooting Guide
  • API Endpoints
    • Project
      • create project
      • Get all projects
      • Get project
      • update project
      • Delete project
    • Agentflows
      • create agentflow
      • get agentflows
      • Get agentflow by projectId and UserId
      • get agentflow by id
      • Add skilled agent to agentflow
      • Update skilled agent
    • Connectors
      • get connectors by projectid
        GET
      • get connector by Id
        GET
      • Delete a connector
        DELETE
      • connector update status
        POST
      • get all available trigger actions
        GET
    • Skills
      • create skill
      • get skills
      • get skills by category'
      • get skills by id
      • skills by name
    • Executeflow
      • create executeflow
      • get executions
      • execute agentflow
      • pause executeflow
      • resume execution
      • cancel executeflow
      • get execution by execution id
      • get execution details for monitoring
    • Customer
      • get customer
      • Get credit history
    • Actions
      • create action
      • get action
    • Files
      • upload files
      • get files by fileid
      • get connector by fileid
      • get files by connector_id
    • Inbox
      • get inbox
    • Tags
      • tags
    • Tasks
      • get tasks
      • get task by id
      • Pause running task
      • resume task
      • Stop task
    • Tables
      • create table
      • create database
      • get tables
      • get records list
      • get table names
      • delete record
      • delete a column
    • Dashboard
      • get dashboard
      • refresh dashboard
      • delete component in dashboard
    • Settings
      • get settings
    • Marketplace
      • get all connectors
      • get marketplace coworkers
      • get marketplace coworker by id
    • Coworker schedules
      • get schedules
      • create coworker schedule
      • get schedule coworker by its id
      • update schedule by its id
      • delete schedule by its id
    • Analytics
      • Get analytics
    • Marketplace coworkers
      • hire a coworker
      • check marketplace coworker update
    • Project member
      • project_member
  1. Connectors

get connector by Id

GET
https://api.wexa.ai/connector/{connector_id}
Last modified:2025-04-25 10:30:53

Get Connector by ID#

Retrieve detailed information about a specific connector by providing its unique connector_id. This endpoint allows you to access metadata such as the connector's name, description, status, and configuration details. It's essential for managing and monitoring the connectors integrated into your automation workflows.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.wexa.ai/connector/' \
--header 'x-api-key;'
Response Response Example
{
  "_id": "67fdea9968df1c3e9580a546",
  "name": "Content creator12",
  "description": "Creates content using AI",
  "category": "content_creator",
  "status": "ready",
  "connector_type": "system",
  "connector_group_tag": null,
  "user_id": null,
  "org_id": "67fdea40aac77be632954f0f",
  "projectID": "67fdea40aac77be632954f13",
  "config": {},
  "tags": [],
  "logo": "https://klotdev.blob.core.windows.net/wexa/92d70903-e331-445f-a34d-eebc93d4a520_429-4292382_generalicons-meeting-social-security-icon-png.png",
  "readme_b64": "IyBDb250ZW50IFdyaXRlciBJbnRlZ3JhdGlvbiBHdWlkZQoKIyMgSW50cm9kdWN0aW9uCgpUaGUgQ29udGVudCBXcml0ZXIgY29ubmVjdG9yIGVuYWJsZXMgc2VhbWxlc3MgaW50ZWdyYXRpb24gd2l0aCB2YXJpb3VzIGNvbnRlbnQgZ2VuZXJhdGlvbiBhbmQgbWFuYWdlbWVudCBwbGF0Zm9ybXMsIGVtcG93ZXJpbmcgdXNlcnMgdG8gYXV0b21hdGUgY29udGVudCBjcmVhdGlvbiwgZWRpdGluZywgYW5kIHB1Ymxpc2hpbmcgdGFza3MuIFRoaXMgZ3VpZGUgcHJvdmlkZXMgY29tcHJlaGVuc2l2ZSBpbnN0cnVjdGlvbnMgb24gY29uZmlndXJpbmcgYW5kIHV0aWxpemluZyB0aGUgQ29udGVudCBXcml0ZXIgQ29ubmVjdG9yIHdpdGhpbiB5b3VyIGFwcGxpY2F0aW9uLgoKIyMgR2V0dGluZyBTdGFydGVkIHdpdGggQ29udGVudCBXcml0ZXIKClRvIGJlZ2luIHVzaW5nIHRoZSBDb250ZW50IFdyaXRlciBjb25uZWN0b3IsIGZvbGxvdyB0aGVzZSBzdGVwczoKCjEuIENyZWF0ZSBhbiBBY2NvdW50OiBWaXNpdCB0aGUgcmVzcGVjdGl2ZSBwbGF0Zm9ybSB3ZWJzaXRlcyBhbmQgc2lnbiB1cCBmb3IgYWNjb3VudHMgaWYgeW91IGhhdmVuJ3QgYWxyZWFkeS4KMi4gU2V0IFVwIFlvdXIgQWNjb3VudDogT25jZSByZWdpc3RlcmVkLCBmYW1pbGlhcml6ZSB5b3Vyc2VsZiB3aXRoIHRoZSBwbGF0Zm9ybSBhbmQgaXRzIGZlYXR1cmVzLCBpbmNsdWRpbmcgY29udGVudCB0ZW1wbGF0ZXMsIHdvcmtmbG93cywgYW5kIHB1Ymxpc2hpbmcgb3B0aW9ucy4KCiMjIENvbmZpZ3VyaW5nIHRoZSBDb250ZW50IFdyaXRlciBDb25uZWN0b3IKClRoZSBDb250ZW50IFdyaXRlciBDb25uZWN0b3IgZG9lcyBub3QgcmVxdWlyZSBhbnkgc3BlY2lmaWMgY29uZmlndXJhdGlvbiBzZXR0aW5ncy4KCiMjIyBDb25maWd1cmF0aW9uIEV4YW1wbGUKCiMjIFV0aWxpemluZyB0aGUgQ29udGVudCBXcml0ZXIgQ29ubmVjdG9yCgpUaGUgQ29udGVudCBXcml0ZXIgY29ubmVjdG9yIHN1cHBvcnRzIHZhcmlvdXMgZnVuY3Rpb25hbGl0aWVzIHByb3ZpZGVkIGJ5IHRoZSBpbnRlZ3JhdGVkIHBsYXRmb3JtcywgaW5jbHVkaW5nOgoKLSBHZW5lcmF0aW5nIENvbnRlbnQ6IENyZWF0ZSBuZXcgY29udGVudCBiYXNlZCBvbiBwcm92aWRlZCBpbnB1dCBzdHJpbmdzLgoKIyMjIEdlbmVyYXRlIENvbnRlbnQKCi0gYGlucHV0YCBjb250ZW50OiBUaGUgaW5wdXQgc3RyaW5nIHRvIGJlIHVzZWQgZm9yIGNvbnRlbnQgZ2VuZXJhdGlvbi4KLSBgb3V0cHV0YCBjb250ZW50OiBUaGUgZ2VuZXJhdGVkIGNvbnRlbnQgc3RyaW5nLgoKIyMgQmVzdCBQcmFjdGljZXMKCi0gT3B0aW1pemUgQ29udGVudCBHZW5lcmF0aW9uOiBFbnN1cmUgeW91ciBpbnB1dCBzdHJpbmdzIGFyZSB3ZWxsLWRlZmluZWQgdG8gbWF4aW1pemUgdGhlIHF1YWxpdHkgYW5kIHJlbGV2YW5jZSBvZiB0aGUgZ2VuZXJhdGVkIGNvbnRlbnQuCi0gRXJyb3IgSGFuZGxpbmc6IEltcGxlbWVudCByb2J1c3QgZXJyb3IgaGFuZGxpbmcgbWVjaGFuaXNtcyB0byBncmFjZWZ1bGx5IGhhbmRsZSBlcnJvcnMgZW5jb3VudGVyZWQgZHVyaW5nIGNvbnRlbnQgZ2VuZXJhdGlvbiBvciBBUEkgaW50ZXJhY3Rpb25zLgotIFNlY3VyaXR5OiBTZWN1cmVseSBtYW5hZ2UgYW5kIHByb3RlY3QgeW91ciBhY2NvdW50IGNyZWRlbnRpYWxzIHRvIHByZXZlbnQgdW5hdXRob3JpemVkIGFjY2VzcyB0byB5b3VyIGFjY291bnRzIGFuZCByZXNvdXJjZXMuCgojIyBDb25jbHVzaW9uCgpJbiBjb25jbHVzaW9uLCB0aGUgQ29udGVudCBXcml0ZXIgQ29ubmVjdG9yIG9mZmVycyBhIHBvd2VyZnVsIHNvbHV0aW9uIGZvciBhdXRvbWF0aW5nIGNvbnRlbnQgY3JlYXRpb24sIGVkaXRpbmcsIGFuZCBwdWJsaXNoaW5nIHRhc2tzIHRocm91Z2ggc2VhbWxlc3MgaW50ZWdyYXRpb24gd2l0aCB2YXJpb3VzIHBsYXRmb3Jtcy4gQnkgbGV2ZXJhZ2luZyB0aGUgY2FwYWJpbGl0aWVzIG9mIHRoZSBpbnRlZ3JhdGVkIHBsYXRmb3JtcywgZGV2ZWxvcGVycyBjYW4gYnVpbGQgc29waGlzdGljYXRlZCBhdXRvbWF0aW9uIHdvcmtmbG93cyB0byBzdHJlYW1saW5lIGNvbnRlbnQgbWFuYWdlbWVudCBhbmQgaW1wcm92ZSBwcm9kdWN0aXZpdHkuIFdpdGggcHJvcGVyIGNvbmZpZ3VyYXRpb24gYW5kIHV0aWxpemF0aW9uIG9mIHRoZSBDb250ZW50IFdyaXRlciBDb25uZWN0b3IsIHVzZXJzIGNhbiBoYXJuZXNzIHRoZSBmdWxsIHBvdGVudGlhbCBvZiB0aGUgaW50ZWdyYXRlZCBwbGF0Zm9ybXMgdG8gZ2VuZXJhdGUgaGlnaC1xdWFsaXR5IGNvbnRlbnQgYW5kIGF1dG9tYXRlIHJlcGV0aXRpdmUgdGFza3MgZWZmZWN0aXZlbHkuCg==",
  "ui_form": [],
  "data_loaders": [],
  "actions": [
    {
      "name": "Content creation",
      "sort": "generate",
      "category": "content_creator",
      "endpoint": "/content_creator/generate",
      "description": "Creates content",
      "is_enabled": true
    }
  ],
  "data_loader_config": {
    "frequency": 1,
    "sync_interval": "daily",
    "meta_data": null
  },
  "price": 0,
  "is_configured": true,
  "is_starred": false,
  "is_deleted": false,
  "triggers": [],
  "available_events": [],
  "is_premium": false,
  "data_to_verify": {
    "account_id": null,
    "url": null,
    "redirect_to_configuration": false,
    "type": null,
    "username": null
  },
  "coworker_metadata": null,
  "files": []
}

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
connector_id
string 
required
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}

Responses

🟢200get connector by Id
application/json
Body
_id
string 
required
name
string 
required
description
string 
required
category
string 
required
status
string 
required
connector_type
string 
required
connector_group_tag
null 
required
user_id
null 
required
org_id
string 
required
projectID
string 
required
config
object 
required
tags
array
required
logo
string 
required
readme_b64
string 
required
ui_form
array
required
data_loaders
array
required
actions
array [object {6}] 
required
name
string 
optional
sort
string 
optional
category
string 
optional
endpoint
string 
optional
description
string 
optional
is_enabled
boolean 
optional
data_loader_config
object 
required
frequency
integer 
required
sync_interval
string 
required
meta_data
null 
required
price
integer 
required
is_configured
boolean 
required
is_starred
boolean 
required
is_deleted
boolean 
required
triggers
array
required
available_events
array
required
is_premium
boolean 
required
data_to_verify
object 
required
account_id
null 
required
url
null 
required
redirect_to_configuration
boolean 
required
type
null 
required
username
null 
required
coworker_metadata
null 
required
files
array
required
Modified at 2025-04-25 10:30:53
Previous
get connectors by projectid
Next
Delete a connector