API Documentation
Authentication
All API requests require authentication using an API key. You can obtain your API key from your account settings.
Authorization: Bearer YOUR_API_KEYBase URL
All API endpoints are relative to the base URL:
https://api.opxplatform.com/v1API Simulator
Test our APIs directly from the documentation. Select an endpoint, add any required parameters, and see the response in real-time.
API Simulator
Test and explore our APIs in real-time
Select an endpoint and send a request to see the response
Workflows
List Workflows
Retrieve a list of all workflows in your organization.
GET /workflowsResponse
{
"workflows": [
{
"id": "string",
"name": "string",
"description": "string",
"created_at": "string",
"updated_at": "string"
}
]
}Create Workflow
Create a new workflow in your organization.
POST /workflowsRequest Body
{
"name": "string",
"description": "string",
"steps": [
{
"name": "string",
"type": "string",
"config": {}
}
]
}Tasks
List Tasks
Retrieve a list of all tasks.
GET /tasksQuery Parameters
status- Filter by task statusassignee- Filter by assigneepage- Page number for pagination
Create Task
Create a new task.
POST /tasksRequest Body
{
"title": "string",
"description": "string",
"assignee_id": "string",
"due_date": "string",
"priority": "string"
}Users
List Users
Retrieve a list of all users in your organization.
GET /usersResponse
{
"users": [
{
"id": "string",
"name": "string",
"email": "string",
"role": "string",
"created_at": "string"
}
]
}Create User
Create a new user in your organization.
POST /usersRequest Body
{
"name": "string",
"email": "string",
"role": "string",
"password": "string"
}