Customer Details

This endpoint allows you to return a specific customer's details by passing the customer as a path parameter.

The rate limit for the customers endpoints is 500 request per 10 minutes. For more details, please visit the Rate Limiting & change log documentation page.

Scopes

customers.read- Customers Read Only

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (Customer)

optional

Detailed structure of the customer model object showing its fields and data types.

number

required

A unique identifier for the customer.

first_name

string

required

The customer's first name.

<= 25 characters

last_name

string

required

The customer's last name.

<= 25 characters

mobile

number

required

The customer's mobile phone number without the country code.

mobile_code

string

required

The country code for the customer's mobile phone number.

string <email>

required

The customer's email address.

urls

object (Urls)

required

A list of URLs associated with the customer, such as their website or social media profiles.

avatar

string

required

A URL to the customer's avatar image.

gender

enum<string>

required

The customer's gender.

Allowed values:

malefemale

birthday

object

required

city

string

required

The city where the customer lives.

country

string

required

The country where the customer lives.

country_code

string

required

The country code for the customer's country.

currency

string

required

The currency that the customer uses.

location

string

required

The customer's location, represented as a string.

updated_at

object (Date)

required

The date and time when the customer's information was last updated.

groups

array[integer]

required

A list of group IDs that the customer belongs to.

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 2075683582,
        "first_name": "Ahmed",
        "last_name": "Ali",
        "mobile": 777777777,
        "mobile_code": "967",
        "email": "ahmedali@test.test",
        "urls": {
            "customer": "https://shtara.com/profile",
            "admin": "https://shtara.com/profiley"
        },
        "avatar": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
        "gender": "male",
        "city": "Riyadh",
        "country": "السعودية",
        "country_code": "sa",
        "location": "null",
        "updated_at": {
            "date": "2020-04-02 22:43:26.000000",
            "timezone_type": 3,
            "timezone": "Asia/Riyadh"
        },
        "groups": [
            11323141,
            11323142
        ]
    }
}

🟠404Not Found

🟠401Unauthorized

Request

Request samples

Responses