[FEATURE] : add pagination support for customers list · juspay/hyperswitch#3746

2024-02-21T07:28:32.000Z

### Feature Description The [customers list](https://github.com/juspay/hyperswitch/blob/4ae28e48cd73a9f96b6ae24babf167824fd182a0/crates/router/src/routes/customers.rs#L68) endpoint currently has no pagination support. It returns the list of all the customers in the database. There would be thousands of customers for a merchant. A pagination support for the api would be necessary. ### Possible Implementation accept two fields, `limit` and `offset` - `limit` specifies the number of objects returned in the response. - `offset` specifies the number of items to skip from the start, this is open to discussion whether to use offset or some other field. This would be similar to the `payments_list` pagination. Refer [here](https://github.com/juspay/hyperswitch/blob/54c0b218d9f20c6388dde0f30ea525011cdad573/crates/router/src/routes/payments.rs#L868) ### Have you spent some time checking if this feature request has been raised before? - [X] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [X] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

(7 comments) (0 reactions) (0 assignees)Rust (4,676 forks)batch import

C-featuregood first issuehelp wanted

Repository metrics

Stars: (42,690 stars)
PR merge metrics: (Avg merge 6d 22h) (213 merged PRs in 30d)

Description

Feature Description

The customers list endpoint currently has no pagination support. It returns the list of all the customers in the database. There would be thousands of customers for a merchant. A pagination support for the api would be necessary.

Possible Implementation

accept two fields, limit and offset

limit specifies the number of objects returned in the response.
offset specifies the number of items to skip from the start, this is open to discussion whether to use offset or some other field.

This would be similar to the payments_list pagination. Refer here

Have you spent some time checking if this feature request has been raised before?

I checked and didn't find a similar issue

Have you read the Contributing Guidelines?

I have read the Contributing Guidelines

Are you willing to submit a PR?

None

Contributor guide

Research direction: Study the existing payments list pagination implementation at the referenced link and replicate the pattern for the customers list endpoint, adding limit and offset query parameters.
Tech stack: rust
Domain: backend
Issue type: Feature
Difficulty: 3
Estimated time: Half day
Activity status: Active
Clarity: Clear
Prerequisites: RustHyperswitch codebase familiarity
Newbie friendliness: 70