Skip to main content
GET
/
v1
/
executors
/
{id}
Get an Executor Configuration
curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/executors/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "name": "Serasa KYC",
  "description": "Serasa identity validation service",
  "baseUrl": "https://api.serasa.com.br/v2",
  "endpoints": [
    {
      "name": "validate-identity",
      "path": "/identity/validate",
      "method": "POST",
      "timeout": 30
    }
  ],
  "authentication": {
    "type": "api_key",
    "config": {
      "key": "********",
      "header": "X-API-Key"
    }
  },
  "status": "active",
  "metadata": {},
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-16T09:30:00Z",
  "lastTestedAt": "2026-03-16T09:30:00Z"
}

Authorizations

X-API-Key
string
header
required

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Path Parameters

id
string<uuid>
required

Unique identifier of the executor configuration.

Response

Indicates that the request was successful and the response contains the requested data.

authentication
object
baseUrl
string

Base URL of the external service.

Example:

"https://api.serasa.com.br/v2"

createdAt
string<date-time>

Timestamp when the configuration was created.

Example:

"2026-03-15T10:00:00Z"

description
string

Human-readable description.

Example:

"Serasa identity validation service"

endpoints
object[]

List of configured HTTP endpoints.

id
string<uuid>

Unique identifier of the executor configuration.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

lastTestedAt
string<date-time>

Timestamp of the last connectivity test. Null if never tested.

Example:

"2026-03-16T09:30:00Z"

metadata
object

Custom metadata.

name
string

Display name.

Example:

"Serasa KYC"

status
enum<string>

Current lifecycle status: unconfigured, configured, tested, active, or disabled.

Available options:
unconfigured,
configured,
tested,
active,
disabled
Example:

"active"

updatedAt
string<date-time>

Timestamp of the last update.

Example:

"2026-03-16T09:30:00Z"