Get All Customers

curl --request GET \
  --url https://api.rootfi.dev/v3/ecommerce/customers \
  --header 'api_key: <api-key>'

{
  "data": [
    {
      "rootfi_id": 157,
      "rootfi_created_at": "2024-01-22T05:07:31.465Z",
      "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
      "rootfi_company_id": 1089,
      "platform_id": "123456",
      "rootfi_deleted_at": "2023-11-07T05:31:56Z",
      "platform_unique_id": "<string>",
      "raw_data": {},
      "data_hash": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "currency_id": "<string>",
      "status": "ACTIVE",
      "updated_at": "<string>",
      "created_at": "<string>",
      "address": {
        "rootfi_id": 123,
        "platform_id": "<string>",
        "street": "<string>",
        "locality": "<string>",
        "city": "<string>",
        "state": "<string>",
        "pincode": "<string>",
        "country": "<string>"
      }
    }
  ],
  "prev": "<string>",
  "next": "<string>",
  "total_count": 123
}

GET

ecommerce

customers

Get All Customers

curl --request GET \
  --url https://api.rootfi.dev/v3/ecommerce/customers \
  --header 'api_key: <api-key>'

{
  "data": [
    {
      "rootfi_id": 157,
      "rootfi_created_at": "2024-01-22T05:07:31.465Z",
      "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
      "rootfi_company_id": 1089,
      "platform_id": "123456",
      "rootfi_deleted_at": "2023-11-07T05:31:56Z",
      "platform_unique_id": "<string>",
      "raw_data": {},
      "data_hash": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "currency_id": "<string>",
      "status": "ACTIVE",
      "updated_at": "<string>",
      "created_at": "<string>",
      "address": {
        "rootfi_id": 123,
        "platform_id": "<string>",
        "street": "<string>",
        "locality": "<string>",
        "city": "<string>",
        "state": "<string>",
        "pincode": "<string>",
        "country": "<string>"
      }
    }
  ],
  "prev": "<string>",
  "next": "<string>",
  "total_count": 123
}

The Customers Data Model is designed to streamline the management and retrieval of account-related information across various ecommerce platforms.

Authorizations

api_key

string

header

required

Query Parameters

limit

integer | null

The number of customers you want to retrieve

string | null

The next page of objects to retrieve

string | null

The previous page of objects to retrieve

select

string | null

Comma separated fields to select. Supported values are raw_data, data_hash

rootfi_updated_at[gte]

string | null

Filter by rootfi_updated_at Greater than or Equal To.

rootfi_company_id[eq]

integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]

include_deleted_records

string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

return_count

string | null

Return the count of the objects. Supported values are true and false

sort[rootfi_created_at]

enum<string> | null

Sort by rootfi_created_at

Available options:

ASC,

DESC

sort[rootfi_updated_at]

enum<string> | null

Sort by rootfi_updated_at

Available options:

ASC,

DESC

Response

The data of the customers endpoint.

data

ecommerceCustomerObject · object[]

required

Show child attributes

data.rootfi_id

number<double>

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string<date-time>

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.rootfi_updated_at

string<date-time>

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.rootfi_company_id

number<double>

required

The ID of the company in the accounting platform

Example:

1089

data.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.rootfi_deleted_at

string<date-time> | null

The date at which the data was deleted in the accounting platform

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.raw_data

object

A JSON containing fields that you can directly get from the accounting platform.

data.data_hash

string | null

The hash of the data

data.name

string | null

The name of the customer

data.email

string | null

The email of the customer

data.phone

string | null

The phone of the customer

data.currency_id

string | null

The currency of the customer

data.status

enum<string> | null

The status of the customer

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.updated_at

string | null

The updated_at of the customer

data.created_at

string | null

The created_at of the customer

data.address

ecommerceAddressObject · object

The address of the customer

Show child attributes

data.address.rootfi_id

integer | null

The RootFi ID of the customer

data.address.platform_id

string | null

The platform ID of the customer

data.address.street

string | null

The street of the address

data.address.locality

string | null

The locality of the address

data.address.city

string | null

The city of the address

data.address.state

string | null

The state of the address

data.address.pincode

string | null

The pincode of the address

data.address.country

string | null

The country of the address

string | null

The previous page of objects to retrieve

string | null

The next page of objects to retrieve

total_count

integer | null

The total count of the objects

Overview Create Customer

⌘I

General

Server Side SDKs

Core API

Unified API

Get All Customers

Authorizations

Query Parameters

Response