API · AUTH · DISCOVERY

NYA Developer Resources

NYA Interior Design Software exposes a small HTTP API for connecting external forms and workflow tools to workspace projects and leads. This page documents the public surface that exists today. The machine-readable contract is the NYA OpenAPI 3.1 document.

Authentication

Requests use the API and Clipper token from the workspace Settings page as an HTTP bearer credential. Treat the token like a password: never place it in browser-side JavaScript, a public repository, a screenshot, a URL, or a support message.

Authorization: Bearer YOUR_NYA_API_TOKEN
Content-Type: application/json

Current endpoints

MethodPath
GET/api/v1/projects
POST/api/v1/projects
GET/api/v1/leads
POST/api/v1/leads

Creating a project accepts name, client_name, and address. Creating a lead accepts name,email, phone, project_type, a numeric budget, notes, and source. The OpenAPI document is the precise field and response reference.

Responses and errors

List operations return HTTP 200 and successful create operations return HTTP 201. Missing or invalid bearer credentials return HTTP 401. Invalid JSON and rejected input return HTTP 400. API responses are JSON and include an error string when a request fails.

Webhooks and MCP status

NYA does not currently offer outbound webhooks. Internal webhooks used by NYA's own infrastructure are not a customer event API. NYA also does not currently offer a public MCP server. Agents should not infer either capability from private application routes or service integrations.

If your workflow needs event delivery, an agent tool, or another API operation, contact NYA with the event, desired payload, and destination. Do not include an API token in that message.

Machine-readable discovery