Skip to main content
GET
/
frontend
/
customer-list
cURL
curl --request GET \
  --url https://api.olimi.ai/frontend/customer-list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "customers": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com"
      }
    ]
  }
]
Fetches all available customer-list. No parameters are required for this endpoint.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

List of customer-list.

id
string<uuid>
required

Unique identifier for the customer list

name
string
required

Name of the customer list

created_at
string<date-time>
required

Timestamp when the customer list was created

description
string

Optional description of the customer list

updated_at
string<date-time>

Timestamp when the customer list was last updated

customers
object[]

Array of customers in the customer list

I