Customers

get
All Customers

https://yoursite.mavenseed.com/api/v1/customers
Retrieve all customers
Request
Response
Path Parameters
page
optional
integer
Results are paginated.
Headers
Authorization
required
string
Auth token
200: OK
Returns an array of members. Only the first 20 are returned. Passing the page param will paginate the results.
[
{
"id": 1976,
"first_name": "api",
"last_name": "test",
"email": "anothertest@sdsdsd.com",
"created_at": "2019-10-17T11:20:05.223-04:00",
"updated_at": "2019-10-17T11:20:05.223-04:00",
"avatar_data": null,
"stripe_customer_id": null,
"vat_number": null,
"address": null,
"zipcode": null,
"city": null,
"state": null,
"country": null
},
{
"id": 1974,
"first_name": "api",
"last_name": "test",
"email": "apitest@sdsdsd.com",
"created_at": "2019-10-16T17:34:43.302-04:00",
"updated_at": "2019-10-16T17:34:43.302-04:00",
"avatar_data": null,
"stripe_customer_id": null,
"vat_number": null,
"address": null,
"zipcode": null,
"city": null,
"state": null,
"country": null
}
]

get
Show Customer

https://yoursite.mavenseed.com/api/v1/customers/:id
Retrieve a single member
Request
Response
Headers
Authorization
required
string
Auth token
200: OK
{
"id": 1976,
"first_name": "api",
"last_name": "test",
"email": "anothertest@sdsdsd.com",
"created_at": "2019-10-17T11:20:05.223-04:00",
"updated_at": "2019-10-17T11:20:05.223-04:00",
"avatar_data": null,
"stripe_customer_id": null,
"vat_number": null,
"address": null,
"zipcode": null,
"city": null,
"state": null,
"country": null
}
404: Not Found
null

post
Create Customer

https://yoursite.mavenseed.com/v1/customers
Create a customer.
Request
Response
Headers
Authorization
required
string
Auth Token
Form Data Parameters
first_name
required
string
Customer first name
last_name
required
string
Customer last name
email
required
string
Email of customer
avatar_data
optional
string
Hash of avatar image data (n/a in API)
stripe_customer_id
optional
string
Stripe Customer ID
vat_number
optional
string
VAT Business number
address
optional
string
Customer address
zipcode
optional
string
Customer zipcode
city
optional
string
Customer city
state
optional
string
Customer state (2 letter iso code)
country
optional
string
Customer country (2 letter iso code)
200: OK
{
"id": 1976,
"first_name": "api",
"last_name": "test",
"email": "anothertest@sdsdsd.com",
"created_at": "2019-10-17T11:20:05.223-04:00",
"updated_at": "2019-10-17T11:20:05.223-04:00",
"avatar_data": null,
"stripe_customer_id": null,
"vat_number": null,
"address": null,
"zipcode": null,
"city": null,
"state": null,
"country": null
}

patch
Update Customer

https://yoursite.mavenseed.com/v1/customers/:id
Update a single customer. All of the above properties in create customer are valid.
Request
Response
Headers
Authorization
optional
string
Auth token
200: OK
{
"id": 1976,
"first_name": "api",
"last_name": "test",
"email": "anothertest@sdsdsd.com",
"created_at": "2019-10-17T11:20:05.223-04:00",
"updated_at": "2019-10-17T11:20:05.223-04:00",
"avatar_data": null,
"stripe_customer_id": null,
"vat_number": null,
"address": null,
"zipcode": null,
"city": null,
"state": null,
"country": null
}

delete
Delete a Customer

https://yoursite.mavenseed.com/v1/customers/:id
Delete a customer.
Request
Response
Headers
Authorization
required
string
Auth token.
200: OK
‚Äč