Customers

This object represents a customer of your business

ListCustomers retrieves the list of customers.

GET/v1/customers

Query parameters

Response

200default

A successful response.

Body

application/json

customersarray of mentiumpublicapicustomersv1Customer (object)

List of customers.

nextPageTokenstring

Pagination token for the next set of results.

Request

JavaScriptCurl

const response = await fetch('/v1/customers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "customers": [
    {
      "id": "text",
      "customerReferenceId": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "createdAt": "2024-05-06T13:46:50.163Z",
      "updatedAt": "2024-05-06T13:46:50.163Z"
    }
  ],
  "nextPageToken": "text"
}

CreateCustomer creates a new customer.

POST/v1/customers

Body

application/json

CreateCustomerRequest represents the request for creating a new customer.

emailstring

Email address of the customer.

firstNamestring

First name of the customer.

lastNamestring

Last name of the customer.

phonestring

Phone number of the customer.

customerReferenceIdstring

(Optional) Customer reference ID for tracking requests across your system.

Response

200default

A successful response.

Body

application/json

idstring

Unique identifier for the customer.

customerReferenceIdstring

Customer reference ID for tracking requests across your system.

emailstring

Email address of the customer.

firstNamestring

First name of the customer.

lastNamestring

Last name of the customer.

phonestring

Phone number of the customer.

createdAtstring (date-time)

The date and time when the customer was created.

updatedAtstring (date-time)

The date and time when the customer was last updated.

Request

JavaScriptCurl

const response = await fetch('/v1/customers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "customerReferenceId": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "phone": "text",
  "createdAt": "2024-05-06T13:46:50.163Z",
  "updatedAt": "2024-05-06T13:46:50.163Z"
}

GetCustomer retrieves a specific customer by ID.

GET/v1/customers/{customerId}

Path parameters

customerId*string

ID of the customer to be retrieved.

Response

200default

A successful response.

Body

application/json

idstring

Unique identifier for the customer.

customerReferenceIdstring

Customer reference ID for tracking requests across your system.

emailstring

Email address of the customer.

firstNamestring

First name of the customer.

lastNamestring

Last name of the customer.

phonestring

Phone number of the customer.

createdAtstring (date-time)

The date and time when the customer was created.

updatedAtstring (date-time)

The date and time when the customer was last updated.

Request

JavaScriptCurl

const response = await fetch('/v1/customers/{customerId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "customerReferenceId": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "phone": "text",
  "createdAt": "2024-05-06T13:46:50.163Z",
  "updatedAt": "2024-05-06T13:46:50.163Z"
}

DeleteCustomer deletes an existing customer by ID.

DELETE/v1/customers/{customerId}

Path parameters

customerId*string

ID of the customer to be deleted.

Response

200default

A successful response.

Body

application/json

mentiumpublicapicustomersv1DeleteCustomerResponse (object)

DeleteCustomerResponse represents the response for the delete operation.

Request

JavaScriptCurl

const response = await fetch('/v1/customers/{customerId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();