Customers
CRM Resources · 5 endpoints
GET
/v1/customersList Customers
app_install_bearerscope: customers:read
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
statusquery | string | optional | active, inactive, lead, prospect, pending |
customer_typequery | string | optional | individual, business, government, non_profit |
limitquery | integer | optional | |
starting_afterquery | string | optional | |
ending_beforequery | string | optional |
Returns · 200
| Field | Type | Required | Description |
|---|---|---|---|
data | CustomerListResponse | required | |
data.has_more | boolean | required | |
data.items | CustomerObject[] | required | |
data.items[].account_number | string | optional | |
data.items[].business_number | string | optional | |
data.items[].city | string | optional | |
data.items[].company_name | string | optional | |
data.items[].country | string | optional | |
data.items[].created_at | string |
Errors 400401403404409422429500
curl https://api.getmeonline.io/v1/customers \
-H "Authorization: Bearer $GETME_API_KEY"POST
/v1/customersCreate Customer
app_install_bearerscope: customers:writeidempotent
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
Idempotency-Keyheader | string | required | Unique key used to make this mutation retry-safe for the replay window. |
Request body · application/json
| Field | Type | Required | Description |
|---|---|---|---|
business_number | string | optional | |
city | string | optional | |
company_name | string | optional | |
country | string | optional | |
currency_code | string |
GET
/v1/customers/{customer_id}Get Customer
app_install_bearerscope: customers:read
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_idpath | string | required | Customer public identifier in cust_<21 Base62> format. |
Returns · 200
| Field | Type | Required | Description |
|---|---|---|---|
data | CustomerObject | required | |
data.account_number | string | optional | |
data.business_number | string | optional | |
data.city | string | optional | |
data.company_name | string |
PATCH
/v1/customers/{customer_id}Update Customer
app_install_bearerscope: customers:writeidempotent
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_idpath | string | required | Customer public identifier in cust_<21 Base62> format. |
Idempotency-Keyheader | string | required | Unique key used to make this mutation retry-safe for the replay window. |
Request body · application/json
| Field | Type | Required | Description |
|---|---|---|---|
business_number | string | optional | |
city | string | optional | |
company_name | string | optional |
POST
/v1/customers/{customer_id}/archiveArchive Customer
app_install_bearerscope: customers:writeidempotent
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_idpath | string | required | Customer public identifier in cust_<21 Base62> format. |
Idempotency-Keyheader | string | required | Unique key used to make this mutation retry-safe for the replay window. |
Returns · 200
| Field | Type | Required | Description |
|---|---|---|---|
data | CustomerObject | required | |
data.account_number | string | optional | |
data.business_number | string | optional |