Organization Enrichments

Endpointhttps://app.monad.com/api

Download schema

Organization-specific enrichment endpoints

List enrichments

GET

https://app.monad.com/api

/v3/{organization_id}/enrichments

Authorization (header)

x-api-key (header)

List all enrichments for an organization

List enrichments › path Parameters

organization_id

string · required

Organization ID

List enrichments › query Parameters

limit

integer

Number of results to return (default 100)

offset

integer

Number of results to skip (default 0)

List enrichments › Responses

List of enrichments

object[]

object

Create enrichment

POST

https://app.monad.com/api

/v3/{organization_id}/enrichments

Authorization (header)

x-api-key (header)

Create a new enrichment with configuration including secrets handling

Create enrichment › path Parameters

organization_id

string · required

Organization ID

Create enrichment › query Parameters

test_connection

boolean

Test connection before creating the enrichment

Create enrichment › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Create enrichment › Responses

Enrichment created successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Test enrichment connection

POST

https://app.monad.com/api

/v3/{organization_id}/enrichments/test-connection

Authorization (header)

x-api-key (header)

Tests the connection for a given enrichment type and configuration

Test enrichment connection › path Parameters

organization_id

string · required

Organization ID

Test enrichment connection › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Test enrichment connection › Responses

Connection test successful

message

string

Get enrichment

GET

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Get an enrichment by ID

Get enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Get enrichment › Responses

Enrichment details

object[]

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

GET/v3/{organization_id}/enrichments/{enrichment_id}

curl --request GET \
  --url https://app.monad.com/api/v3/:organization_id/enrichments/:enrichment_id

shell

Example Responses

{
  "component_of": [
    {
      "component_tier": 0,
      "created_at": "created_at",
      "cron_schedule": "cron_schedule",
      "description": "description",
      "enabled": true,
      "id": "id",
      "input_id": "input_id",
      "managed_by": "customer",
      "name": "name",
      "organization_id": "organization_id",
      "status": {
        "average_size_egressed": 0,
        "average_size_ingested": 0,
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_updated_at": "last_updated_at",
        "nodes": [
          {
            "avg_bytes_per_record_egress": 0,
            "avg_bytes_per_record_ingress": 0,
            "backpressure": {
              "bytes": 0,
              "records": 0
            },
            "component_type": "component_type",
            "component_type_id": "component_type_id",
            "egress": {
              "bytes": 0,
              "records": 0
            },
            "errors": 0,
            "ingress": {
              "bytes": 0,
              "records": 0
            },
            "last_ingested_time": "last_ingested_time",
            "last_record_processed_time": "last_record_processed_time",
            "last_updated_at": "last_updated_at",
            "node_id": "node_id",
            "node_slug": "node_slug",
            "progress": {
              "entries": [
                {
                  "label": "Last Processed",
                  "partition_key": "partition_key",
                  "ranges": [
                    {
                      "end": "end",
                      "start": "start"
                    }
                  ]
                }
              ]
            },
            "status": "Unknown"
          }
        ],
        "organization_id": "organization_id",
        "organization_name": "organization_name",
        "pipeline_id": "pipeline_id",
        "pipeline_name": "pipeline_name",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown",
        "stream": {
          "bytes": 0,
          "records": 0
        }
      },
      "updated_at": "updated_at"
    }
  ],
  "config": {
    "secrets": {
      "key": {}
    },
    "settings": {
      "key": {}
    }
  },
  "created_at": "created_at",
  "description": "description",
  "id": "id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "type": "type",
  "updated_at": "updated_at"
}

json

application/json

Replace enrichment

PUT

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Replace an existing enrichment with new configuration including secrets handling

Replace enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Replace enrichment › query Parameters

test_connection

boolean

Test connection before updating the enrichment

Replace enrichment › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Replace enrichment › Responses

Enrichment updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Delete enrichment

DELETE

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Delete an enrichment by ID

Delete enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Delete enrichment › Responses

Enrichment deleted successfully

message

string

Update enrichment

PATCH

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Update an existing enrichment with new configuration including secrets handling

Update enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Update enrichment › query Parameters

test_connection

boolean

Test connection before updating the enrichment

Update enrichment › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update enrichment › Responses

Enrichment updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Enrichments Enrichment Sandbox

Monad API

Organization Enrichments

Endpointhttps://app.monad.com/api

Download schema

Organization-specific enrichment endpoints

List enrichments

GET

https://app.monad.com/api

/v3/{organization_id}/enrichments

Authorization (header)

x-api-key (header)

List all enrichments for an organization

List enrichments › path Parameters

organization_id

string · required

Organization ID

List enrichments › query Parameters

limit

integer

Number of results to return (default 100)

offset

integer

Number of results to skip (default 0)

List enrichments › Responses

List of enrichments

object[]

object

Create enrichment

POST

https://app.monad.com/api

/v3/{organization_id}/enrichments

Authorization (header)

x-api-key (header)

Create a new enrichment with configuration including secrets handling

Create enrichment › path Parameters

organization_id

string · required

Organization ID

Create enrichment › query Parameters

test_connection

boolean

Test connection before creating the enrichment

Create enrichment › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Create enrichment › Responses

Enrichment created successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Test enrichment connection

POST

https://app.monad.com/api

/v3/{organization_id}/enrichments/test-connection

Authorization (header)

x-api-key (header)

Tests the connection for a given enrichment type and configuration

Test enrichment connection › path Parameters

organization_id

string · required

Organization ID

Test enrichment connection › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Test enrichment connection › Responses

Connection test successful

message

string

Get enrichment

GET

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Get an enrichment by ID

Get enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Get enrichment › Responses

Enrichment details

object[]

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

GET/v3/{organization_id}/enrichments/{enrichment_id}

curl --request GET \
  --url https://app.monad.com/api/v3/:organization_id/enrichments/:enrichment_id

shell

Example Responses

{
  "component_of": [
    {
      "component_tier": 0,
      "created_at": "created_at",
      "cron_schedule": "cron_schedule",
      "description": "description",
      "enabled": true,
      "id": "id",
      "input_id": "input_id",
      "managed_by": "customer",
      "name": "name",
      "organization_id": "organization_id",
      "status": {
        "average_size_egressed": 0,
        "average_size_ingested": 0,
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_updated_at": "last_updated_at",
        "nodes": [
          {
            "avg_bytes_per_record_egress": 0,
            "avg_bytes_per_record_ingress": 0,
            "backpressure": {
              "bytes": 0,
              "records": 0
            },
            "component_type": "component_type",
            "component_type_id": "component_type_id",
            "egress": {
              "bytes": 0,
              "records": 0
            },
            "errors": 0,
            "ingress": {
              "bytes": 0,
              "records": 0
            },
            "last_ingested_time": "last_ingested_time",
            "last_record_processed_time": "last_record_processed_time",
            "last_updated_at": "last_updated_at",
            "node_id": "node_id",
            "node_slug": "node_slug",
            "progress": {
              "entries": [
                {
                  "label": "Last Processed",
                  "partition_key": "partition_key",
                  "ranges": [
                    {
                      "end": "end",
                      "start": "start"
                    }
                  ]
                }
              ]
            },
            "status": "Unknown"
          }
        ],
        "organization_id": "organization_id",
        "organization_name": "organization_name",
        "pipeline_id": "pipeline_id",
        "pipeline_name": "pipeline_name",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown",
        "stream": {
          "bytes": 0,
          "records": 0
        }
      },
      "updated_at": "updated_at"
    }
  ],
  "config": {
    "secrets": {
      "key": {}
    },
    "settings": {
      "key": {}
    }
  },
  "created_at": "created_at",
  "description": "description",
  "id": "id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "type": "type",
  "updated_at": "updated_at"
}

json

application/json

Replace enrichment

PUT

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Replace an existing enrichment with new configuration including secrets handling

Replace enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Replace enrichment › query Parameters

test_connection

boolean

Test connection before updating the enrichment

Replace enrichment › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Replace enrichment › Responses

Enrichment updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Delete enrichment

DELETE

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Delete an enrichment by ID

Delete enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Delete enrichment › Responses

Enrichment deleted successfully

message

string

Update enrichment

PATCH

https://app.monad.com/api

/v3/{organization_id}/enrichments/{enrichment_id}

Authorization (header)

x-api-key (header)

Update an existing enrichment with new configuration including secrets handling

Update enrichment › path Parameters

organization_id

string · required

Organization ID

enrichment_id

string · required

Enrichment ID

Update enrichment › query Parameters

test_connection

boolean

Test connection before updating the enrichment

Update enrichment › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update enrichment › Responses

Enrichment updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Enrichments Enrichment Sandbox