Wexa AI
  1. Settings
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 connector by Id
      • Delete a connector
      • connector update status
      • get all available trigger actions
    • 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
        GET
    • 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. Settings

get settings

GET
https://api.wexa.ai/settings/{projectID}
Last modified:2025-04-25 12:13:02

Retrieve Project Settings#

Use this endpoint to retrieve the configuration settings for a specific project within your Wexa.ai environment. Accessing project settings allows you to view and manage various parameters that govern the behavior and integration of your AI Coworkers, connectors, and workflows.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.wexa.ai/settings/' \
--header 'x-api-key: {{x-api-key}}'
Response Response Example
{
  "projectID": "67fdea40aac77be632954f13",
  "reference_mapping": [],
  "user_connectors": [],
  "connector_group": [],
  "user_settings_schema": {
    "template": "",
    "form_elements": []
  },
  "_id": "67fdea9e68df1c3e9580a54c"
}

Request

Path Params
projectID
string 
required
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}

Responses

🟢200get settings
application/json
Body
projectID
string 
required
reference_mapping
array
required
user_connectors
array
required
connector_group
array
required
user_settings_schema
object 
required
template
string 
required
form_elements
array
required
_id
string 
required
Modified at 2025-04-25 12:13:02
Previous
delete component in dashboard
Next
get all connectors