> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.noyax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Noyax API

> Secure, server-to-server access to your Noyax data from your own applications.

Use the Noyax API to connect your ERP, e-commerce, CRM and other systems to Noyax. The API follows REST principles: resources are addressed by URL, request and response bodies are JSON, and results are reported with standard HTTP status codes.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/en/v1/quickstart">
    Get a token and make your first request in 5 minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/en/v1/guides/authentication">
    API key, access token and refresh token flow.
  </Card>

  <Card title="Customers" icon="users" href="/en/v1/customers/overview">
    Rules for customer records and their sub-records.
  </Card>

  <Card title="API reference" icon="code" href="/en/v1/customers/list">
    Every endpoint and field, with a playground to try them.
  </Card>
</CardGroup>

## Basics

|                      |                                                                                    |
| -------------------- | ---------------------------------------------------------------------------------- |
| **Base URL**         | `https://api.noyax.com/api/v1`                                                     |
| **Format**           | JSON (UTF-8). Field names are PascalCase: `CustomerCode`, `TaxNumber`              |
| **Authentication**   | `Authorization: Bearer <access token>`                                             |
| **Required headers** | `X-UserID`, `X-CompanyID` ([details](/en/v1/guides/request-context))               |
| **Dates**            | ISO 8601 in Turkey time (UTC+3), without a time zone offset: `2026-09-17T14:30:00` |
| **Error messages**   | English                                                                            |

## Response format

Every response uses the same envelope. On success `ResultCode` is `0000` and the payload is in `Data`. On failure `Success` is `false`, `ResultCode` identifies the error and `Errors` lists every error with its code.

<CodeGroup>
  ```json Success theme={null}
  {
    "Success": true,
    "ResultCode": "0000",
    "Message": null,
    "Data": {
      "Id": "3f2b8c1e-5d47-4a9b-9e21-6c0d8f7a1b24",
      "CustomerCode": "0000382026",
      "Name": "Example Trading Ltd."
    }
  }
  ```

  ```json Error theme={null}
  {
    "Success": false,
    "ResultCode": "1004",
    "Message": "Name is required. TaxNumber is required.",
    "Errors": [
      { "Code": "1004", "Message": "Name is required." },
      { "Code": "1005", "Message": "TaxNumber is required." }
    ]
  }
  ```
</CodeGroup>

See [Errors](/en/v1/guides/errors) for the error format and [Result codes](/en/v1/guides/result-codes) for all codes.

## Getting access

Your API key and organization name (OrgName) are issued by Noyax. Module permissions (read and/or write) and the daily request limit are defined per API key. Contact Noyax support to request access.

<Warning>
  Keep your API key on the server side only. Never ship it in code that runs on end-user devices, such as browsers or mobile apps.
</Warning>