---
agentTools:
  projectIndex: https://thirdfi.readme.io/llms.txt
---

# Get All Customers

This API is used to get all the customers.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "ThirdFi API",
    "description": "ThirdFi Backend API Documentation",
    "version": "1.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://api.thirdfi.org",
      "description": "Production server (uses live data)"
    },
    {
      "url": "https://sandbox.thirdfi.org",
      "description": "Sandbox server (uses test data)"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "x-sec-key"
      },
      "TimestampHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "x-sec-ts"
      },
      "SecretHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "x-sec-sign"
      }
    },
    "schemas": {
      "ErrorResponseVo": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number"
          },
          "message": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "statusCode",
          "message"
        ]
      }
    }
  },
  "paths": {
    "/api/v1/customers": {
      "get": {
        "operationId": "Customer_findAll",
        "summary": "Get All Customers",
        "description": "This API is used to get all the customers.",
        "parameters": [
          {
            "name": "page",
            "required": false,
            "in": "query",
            "description": "To indicate current page of the listing",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "To indicate number of records return for single page.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "orderBy",
            "required": false,
            "in": "query",
            "description": "Field name in object",
            "schema": {
              "default": "",
              "type": "string"
            }
          },
          {
            "name": "orderSequence",
            "required": false,
            "in": "query",
            "description": "1 - ASC, -1 - DESC, 0 - No sort",
            "schema": {
              "default": 0,
              "type": "number"
            }
          },
          {
            "name": "firstName",
            "required": false,
            "in": "query",
            "description": "Filter by customer's first name",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lastName",
            "required": false,
            "in": "query",
            "description": "Filter by customer's last name",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "emailAddress",
            "required": false,
            "in": "query",
            "description": "Filter by customer's email address",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sandbox",
            "required": false,
            "in": "query",
            "description": "To indicate whether using sandbox or production environment. `false` - production, `true` - sandbox",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Cunstomers fetched.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "type": "number"
                    },
                    "message": {
                      "type": "string"
                    },
                    "data": {
                      "type": "array",
                      "description": "List of customer objects. See https://thirdfi.readme.io/reference/customer-object for more information."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseVo"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseVo"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden Resources",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseVo"
                }
              }
            }
          }
        },
        "tags": [
          "Customer"
        ],
        "security": [
          {
            "ApiKeyHeader": [],
            "TimestampHeader": [],
            "SecretHeader": []
          }
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 6,
      "2": 47,
      "3": 127,
      "4": 211,
      "5": 139,
      "6": 229,
      "7": 0,
      "8": 31,
      "9": 79,
      "10": 42,
      "11": 214
    }
  }
}
```