processmaker.comKnowledge CenterProcessMaker University
Edit

Data Connectors

Returns all Data Connectors categories that the user has access to

get

Display a listing of the Data Connector Categories.

Authorizations
Query parameters
filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
Responses
200

list of Data Connectors categories

application/json
get
/data_source_categories
GET /api/1.0/data_source_categories HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

list of Data Connectors categories

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-10-17T21:26:49.048Z",
      "updated_at": "2025-10-17T21:26:49.048Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Save a new Data Connector Category

post

Store a newly created Data Connector Category in storage

Authorizations
Body
namestringOptional

Represents a business data Source category definition.

statusstring · enumOptionalPossible values:
Responses
201

success

application/json
Responseall of
and
post
/data_source_categories
POST /api/1.0/data_source_categories HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "status": "ACTIVE"
}
201

success

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

Get single Data Connector category by ID

get

Display the specified data Source category.

Authorizations
Path parameters
data_source_category_idstringRequired

ID of Data Connector category to return

Responses
200

Successfully found the Data Connector

application/json
Responseall of
and
get
/data_source_categories/{data_source_category_id}
GET /api/1.0/data_source_categories/{data_source_category_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successfully found the Data Connector

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

Update a Data Connector Category

put

Updates the current element

Authorizations
Path parameters
data_source_category_idstringRequired

ID of Data Connector category to return

Body
namestringOptional

Represents a business data Source category definition.

statusstring · enumOptionalPossible values:
Responses
200

success

application/json
Responseall of
and
put
/data_source_categories/{data_source_category_id}
PUT /api/1.0/data_source_categories/{data_source_category_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "status": "ACTIVE"
}
200

success

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

Delete a Data Connector category

delete

Remove the specified resource from storage.

Authorizations
Path parameters
data_source_category_idstringRequired

ID of Data Connector category to return

Responses
204

success

No content
delete
/data_source_categories/{data_source_category_id}
DELETE /api/1.0/data_source_categories/{data_source_category_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

success

No content

Returns all Data Connectors that the user has access to

get

Get the list of records of a Data Connector

Authorizations
Query parameters
filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

Include data from related models in payload. Comma separated list.

Default: ""
Responses
200

list of Data Connectors

application/json
get
/data_sources
GET /api/1.0/data_sources HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

list of Data Connectors

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "endpoints": "text",
      "mappings": "text",
      "authtype": "text",
      "credentials": "text",
      "status": "text",
      "data_source_category_id": "text",
      "created_at": "2025-10-17T21:26:49.048Z",
      "updated_at": "2025-10-17T21:26:49.048Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Save a new Data Connector

post

Create a new Data Connector.

Authorizations
Body
idstring · idOptional

Class DataSource

namestringOptional
descriptionstringOptional
endpointsstringOptional
mappingsstringOptional
authtypestringOptional
credentialsstringOptional
statusstringOptional
data_source_category_idstringOptional
Responses
201

success

application/json
Responseall of
and
post
/data_sources
POST /api/1.0/data_sources HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text"
}
201

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

Get single Data Connector by ID

get

Get a single Data Connector.

Authorizations
Path parameters
data_source_idstringRequired

ID of Data Connector to return

Responses
200

Successfully found the Data Connector

application/json
Responseall of
and
get
/data_sources/data_source_id
GET /api/1.0/data_sources/data_source_id HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successfully found the Data Connector

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

Update a Data Connector

put

Update a Data Connector.

Authorizations
Path parameters
data_source_idstringRequired

ID of Data Connector to return

Body
idstring · idOptional

Class DataSource

namestringOptional
descriptionstringOptional
endpointsstringOptional
mappingsstringOptional
authtypestringOptional
credentialsstringOptional
statusstringOptional
data_source_category_idstringOptional
Responses
204

success

application/json
Responseall of
and
put
/data_sources/data_source_id
PUT /api/1.0/data_sources/data_source_id HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text"
}
204

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

Delete a Data Connector

delete

Delete a Data Connector.

Authorizations
Path parameters
data_source_idstringRequired

ID of Data Connector to return

Responses
204

success

application/json
Responseall of
and
delete
/data_sources/data_source_id
DELETE /api/1.0/data_sources/data_source_id HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

Send a Data Connector request

post

Send a Data Connector request.

Authorizations
Path parameters
data_source_idstringRequired

ID of Data Connector to return

Body
idstring · idOptional

Class DataSource

namestringOptional
descriptionstringOptional
endpointsstringOptional
mappingsstringOptional
authtypestringOptional
credentialsstringOptional
statusstringOptional
data_source_category_idstringOptional
Responses
204

success

application/json
Responseall of
and
post
/data_sources/data_source_id/test
POST /api/1.0/data_sources/data_source_id/test HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text"
}
204

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-10-17T21:26:49.048Z",
  "updated_at": "2025-10-17T21:26:49.048Z"
}

execute Data Source

post

Execute a data Source endpoint

Authorizations
Path parameters
request_idstringRequired

ID of the request in whose context the datasource will be executed

data_source_idstringRequired

ID of DataSource to be run

Body
Responses
200

success

application/json
post
/requests/{request_id}/data_sources/{data_source_id}
POST /api/1.0/requests/{request_id}/data_sources/{data_source_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "config": {
    "endpoint": "text",
    "dataMapping": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "outboundConfig": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  }
}
200

success

{
  "status": 1,
  "response": {}
}

execute Data Source

post
Authorizations
Path parameters
data_source_idstringRequired

ID of DataSource to be run

Body
dataobjectOptional
Responses
200

success

application/json
post
/requests/data_sources/{data_source_id}
POST /api/1.0/requests/data_sources/{data_source_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "config": {
    "endpoint": "text",
    "dataMapping": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "outboundConfig": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "data": {}
}
200

success

{
  "status": 1,
  "response": {}
}

Get Data from Data Source

post
Authorizations
Path parameters
data_source_idstringRequired

ID of DataSource to be run

endpointstringRequired

Endpoint of the data source

Responses
200

success

application/json
post
/requests/data_sources/{data_source_id}/resources/{endpoint}/data
POST /api/1.0/requests/data_sources/{data_source_id}/resources/{endpoint}/data HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

success

{
  "status": 1,
  "response": {}
}
PreviousAdministrative APIsNextCollections

Last updated