Skip to main content

Get List

GET 
/api/customers

API Endpoint: Retrieve Customers​

Purpose​

This endpoint allows users to retrieve a list of customers from the UdyogX application. It is useful for applications that need to display customer information or perform operations based on customer data.

Request Parameters​

This is a GET request and does not require any input parameters in the request body. However, you may include query parameters for filtering or pagination if supported by the API (not specified in the current documentation).

Response Structure​

The response will contain a JSON object with the following structure:

  • customers: An array of customer objects, each containing:
    • id: Unique identifier for the customer.
    • name: Name of the customer.
    • email: Email address of the customer.
    • phone: Contact number of the customer.
    • address: Address details of the customer.

Example Response​

{
  "customers": [
    {
      "id": "1",
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "1234567890",
      "address": "123 Main St, City, Country"
    },
    ...
  ]
}

This structure allows the consumer to easily access and manipulate customer data as needed.

Responses​