Skip to main content
GET
/
customers
cURL
curl --request GET \
  --url https://api.grainfinance.co/v1/customers \
  --header 'Authorization: Basic <encoded-value>'
{
  "customers": [
    {
      "id": "1b0ada1e-fa1b-4cfe-a553-01b340c5650e",
      "companyName": "Ollivander's Wand Shop",
      "companyCountry": "GB",
      "externalCustomerId": "630231b3ae0d7e9e5097ad35",
      "status": "Pending",
      "companyAddress": "12 Diagon Alley",
      "companyCity": "London",
      "companyState": "London",
      "contactEmail": "customer@company.com",
      "contactFullName": "Garrick Ollivander",
      "contactPhoneNumber": "+12125551234",
      "companyTaxId": "123-45-6789",
      "extraFields": {
        "field_a": "value_a",
        "field_b": "value_b"
      }
    }
  ],
  "pagination": {
    "page": 2,
    "perPage": 50.5,
    "totalResults": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.grainfinance.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/api-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.