> For the complete documentation index, see [llms.txt](https://docs.auctionplusapp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.auctionplusapp.com/admin-api/customers/list-customers.md).

# List customers

Returns a paginated list of customers.

```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Customers","description":"Resolve a customer by their Shopify customer ID by filtering the list on `externalId`."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking <b>Generate API token</b>.","scheme":"bearer"}},"schemas":{"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/customers":{"get":{"operationId":"listCustomers","description":"Returns a paginated list of customers.","summary":"List customers","tags":["Customers"],"parameters":[{"name":"filter[externalId]","in":"query","description":"Filter by the Shopify customer ID","schema":{"type":"string"}},{"name":"perPage","in":"query","description":"Results per page (1–100).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort by field. Prefix with `-` for descending order. Available values: `createdAt`, `-createdAt`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated set of `CustomerResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerResource"}},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","minimum":1},"from":{"type":["integer","null"],"minimum":1},"lastPage":{"type":"integer","minimum":1},"perPage":{"type":"integer","description":"Number of items shown per page.","minimum":0},"to":{"type":["integer","null"],"description":"Number of the last item in the slice.","minimum":1},"total":{"type":"integer","description":"Total number of items being paginated.","minimum":0}},"required":["currentPage","from","lastPage","perPage","to","total"]}},"required":["data","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```