Customers
Properties
id
stringnullableThe Rutter generated unique ID of the customer.
platform_id
stringnullableOptionalThe platform specific ID of the customer.
email
stringnullableThe email of the customer.
first_name
stringnullableThe first name of the customer.
last_name
stringnullableThe last name of the customer.
phone
stringnullableThe phone number of the customer.
created_at
stringnullableThe ISO 8601 timestamp that the customer was created.
updated_at
stringnullableThe ISO 8601 timestamp that the customer was last updated.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Customers
Request Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringqueryOptionalThe cursor to use for pagination. Use the value of next_cursor
provided in a previous response.
email
stringqueryOptionalAn email to filter on.
force_fetch
enumqueryOptionalForce a response even if the underlying connection hasn't finished the initial sync.
limit
integerqueryOptionalThe number of entities to return. Defaults to 50. Maximum is 500.
phone
stringqueryOptionalA phone number formatted using only numerics to filter on.
updated_at_max
integerqueryOptionalUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryOptionalUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributescustomers
arraycustomers
attributesnext_cursor
stringnullable- Shopify
- Woo Commerce
- Amazon
- Squarespace
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "SHOPIFY"
6 },
7 "customers": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "email": "eric@rutter.com",
12 "first_name": "Eric",
13 "last_name": "Yu",
14 "phone": "1234567890",
15 "orders": [
16 {
17 "id": "00000000-0000-0000-0000-000000000000"
18 }
19 ],
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "platform_data": {
23 "id": 123,
24 "data": "Varies by platform"
25 }
26 }
27 ],
28 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
29}
Fetch a Customer
Request Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumqueryOptionalForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributescustomer
nullablecustomer
attributes- Shopify
- Woo Commerce
- Amazon
- Squarespace
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "SHOPIFY"
6 },
7 "customer": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "email": "eric@rutter.com",
11 "first_name": "Eric",
12 "last_name": "Yu",
13 "phone": "1234567890",
14 "orders": [
15 {
16 "id": "00000000-0000-0000-0000-000000000000"
17 }
18 ],
19 "created_at": "2023-01-02T02:34:56.000Z",
20 "updated_at": "2023-01-02T02:34:56.000Z",
21 "platform_data": {
22 "id": 123,
23 "data": "Varies by platform"
24 }
25 }
26}
Have questions?
Contact support for personalized guidance.