Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/keys

Query Parameters

external_customer_id
string

external_customer_id is the customer id, as identified within your system

page
number<double>

page number indicating which set of items to return The page indicating which set of items are returned

Required range: x >= 1
per_page
number<double>

number of items in a page

Required range: 1 <= x <= 100

Response

200 - application/json

Customer Found

A response containing a list of customers matching the search criteria.

customers
object[]
required

A list of customers matching the search criteria.

pagination
object
required

Pagination parameters of the returned results.