> For the complete documentation index, see [llms.txt](https://eventx-hq.gitbook.io/knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eventx-hq.gitbook.io/knowledge-base/api-doc/public-api.md).

# Public Api

## GET /public-api/v1/org/{orgId}/custom-domains

> List custom domains for an organization

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains":{"get":{"responses":{},"parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"status","in":"query","schema":{"type":"string","enum":["pending","active","pending_ssl","moved","failed"]}},{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"listCustomDomains","summary":"List custom domains for an organization"}}}}
```

## POST /public-api/v1/org/{orgId}/custom-domains

> Create a custom domain via Cloudflare

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains":{"post":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"},"defaultRedirectUrl":{"type":"string"}},"required":["domain","defaultRedirectUrl"],"additionalProperties":false}}}},"operationId":"createCustomDomain","summary":"Create a custom domain via Cloudflare"}}}}
```

## GET /public-api/v1/org/{orgId}/custom-domains/{customDomainId}

> Get custom domain details with DNS records

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}":{"get":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"getCustomDomainDetail","summary":"Get custom domain details with DNS records"}}}}
```

## PUT /public-api/v1/org/{orgId}/custom-domains/{customDomainId}

> Update the default redirect URL of a custom domain

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}":{"put":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"defaultRedirectUrl":{"type":"string"}},"required":["defaultRedirectUrl"],"additionalProperties":false}}}},"operationId":"updateCustomDomain","summary":"Update the default redirect URL of a custom domain"}}}}
```

## DELETE /public-api/v1/org/{orgId}/custom-domains/{customDomainId}

> Delete a custom domain

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}":{"delete":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"deleteCustomDomain","summary":"Delete a custom domain"}}}}
```

## Trigger DNS verification for a custom domain

> Initiates DNS ownership and SSL verification checks. Idempotent — can be called multiple times to refresh the verification status.

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}/verify":{"put":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"verifyCustomDomain","summary":"Trigger DNS verification for a custom domain","description":"Initiates DNS ownership and SSL verification checks. Idempotent — can be called multiple times to refresh the verification status."}}}}
```

## GET /public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings

> List path mappings for a custom domain

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings":{"get":{"responses":{},"parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"listPathMappings","summary":"List path mappings for a custom domain"}}}}
```

## POST /public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings

> Create a path mapping for a custom domain

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings":{"post":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string"},"eventRegFormId":{"type":"string"},"pathName":{"type":"string"}},"required":["eventId","pathName"],"additionalProperties":false}}}},"operationId":"createPathMapping","summary":"Create a path mapping for a custom domain"}}}}
```

## PUT /public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings/{pathMappingId}

> Update a path mapping

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings/{pathMappingId}":{"put":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}},{"name":"pathMappingId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string"},"eventRegFormId":{"type":"string","nullable":true},"pathName":{"type":"string"}},"additionalProperties":false}}}},"operationId":"updatePathMapping","summary":"Update a path mapping"}}}}
```

## DELETE /public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings/{pathMappingId}

> Delete a path mapping

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"paths":{"/public-api/v1/org/{orgId}/custom-domains/{customDomainId}/path-mappings/{pathMappingId}":{"delete":{"responses":{},"parameters":[{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}},{"name":"customDomainId","in":"path","required":true,"schema":{"type":"string"}},{"name":"pathMappingId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"deletePathMapping","summary":"Delete a path mapping"}}}}
```