Get vendor user's customer list

Before you try this endpoint, please confirm you already get auth token from the endpoint Get auth token.

When you run this api with your authorization, the backend will check if you are a vendor user with vendor portal access.

Each vendor user has their own managed customers and managed staffs. Customer and staff assignment can be done by a vendor admin (who has access to the vendor portal). Vendor admin also have a list of customers, but by default they can view all customers.

Get customer list

GET /vendor/get_vendor_user

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Required
Description

email

string

Email of the vendor user

Parameter Example

{
  "email": "[email protected]"
}

Response

{
    "id": 1936,
    "access_vendor_portal": false,
    "name": "Vendor user 2",
    "platform_email": "[email protected]",
    "customer_list": [
        {
            "id": 42,
            "name": "Testing",
            "is_active": false
        },
        {
            "id": 5,
            "name": "Customer Testing",
            "is_active": false
        },
        {
            "id": 14,
            "name": "Tigermed",
            "is_active": true
        },
        {
            "id": 1,
            "name": "Test Customer 1",
            "is_active": true
        }
    ],
    "staff_list": [
        {
            "id": 1798,
            "name": "AAA",
            "platform_email": "[email protected]",
            "status": "Offboarded"
        },
        {
            "id": 1997,
            "name": "Test Staff 1",
            "platform_email": "[email protected]",
            "status": "Inactive"
        }
    ]
}

Last updated