Get Member by Email - MSAAQ Documentation

Returns the member ID associated with the provided email address. The email must belong to a registered member.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

string

required

Example:

application/json

X-Tenant

string

required

Example:

Body Params application/json

string <email>

required

The email address of the member to retrieve.

Example

{
    "email": "info@msaaq.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

message

object

required

body

string

required

title

string

required

data

object (MemberResource)

required

integer

required

member

string

required

first_name

string

required

last_name

string

required

name

string

required

english_name

string

required

username

string

required

avatar

object (MediaResource)

required

bio

string

required

job_title

string

required

education

string

required

url

string <uri>

required

courses_count

integer

required

products_count

integer

required

total_purchases

integer

required

orders_count

integer

required

national_id

integer

required

country_code

string

required

currency

string

required

gender

string

required

skills

array[string]

required

string <email>

required

phone_code

integer

required

phone

string

required

international_phone

string

required

dob

string <date-time>

required

email_verified_at

string <date-time>

required

phone_verified_at

string <date-time>

required

is_verified

boolean

required

status

enum<string>

required

Allowed values:

activeinactive

newsletter_status

enum<string>

required

Allowed values:

subscribedunsubscribedbouncedsoft_bouncedsuppressed

newsletter_subscribed_at

string <date-time>

required

newsletter_unsubscribed_at

string <date-time>

optional

balance

number

required

last_seen_at

string <date-time>

required

updated_at

string <date-time>

required

created_at

string <date-time>

required

segments

object (SegmentResource)

required

meta

object

required

Example

{
    "message": {
        "body": "string",
        "title": "string"
    },
    "data": {
        "id": 0,
        "member": "string",
        "first_name": "string",
        "last_name": "string",
        "name": "string",
        "english_name": "string",
        "username": "string",
        "avatar": {
            "id": 0,
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "name": "string",
            "url": "http://example.com",
            "size": 0,
            "mime": "string"
        },
        "bio": "string",
        "job_title": "string",
        "education": "string",
        "url": "http://example.com",
        "courses_count": 0,
        "products_count": 0,
        "total_purchases": 0,
        "orders_count": 0,
        "national_id": 0,
        "country_code": "string",
        "currency": "string",
        "gender": "string",
        "skills": [
            "string"
        ],
        "email": "user@example.com",
        "phone_code": 0,
        "phone": "string",
        "international_phone": "string",
        "dob": "2019-08-24T14:15:22Z",
        "email_verified_at": "2019-08-24T14:15:22Z",
        "phone_verified_at": "2019-08-24T14:15:22Z",
        "is_verified": true,
        "status": "active",
        "newsletter_status": "subscribed",
        "newsletter_subscribed_at": "2019-08-24T14:15:22Z",
        "newsletter_unsubscribed_at": "2019-08-24T14:15:22Z",
        "balance": 0,
        "last_seen_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "created_at": "2019-08-24T14:15:22Z",
        "segments": {
            "id": 0,
            "name": "string",
            "icon": "string",
            "tags": {
                "id": "string",
                "name": "string",
                "members": [
                    {}
                ],
                "members_count": 0,
                "updated_at": "2019-08-24T14:15:22Z",
                "created_at": "2019-08-24T14:15:22Z"
            },
            "products": "string",
            "courses": [
                {
                    "id": 0,
                    "title": "string",
                    "url": "http://example.com",
                    "thumbnail": {
                        "id": 0,
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "url": "http://example.com",
                        "size": 0,
                        "mime": "string"
                    },
                    "avg_rating": 0,
                    "sales": 0,
                    "publish_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "created_at": "string"
                }
            ],
            "members_count": 0,
            "updated_at": "2019-08-24T14:15:22Z",
            "created_at": "2019-08-24T14:15:22Z"
        },
        "tags": [
            {
                "id": "string",
                "name": "string",
                "members": [
                    {}
                ],
                "members_count": 0,
                "updated_at": "2019-08-24T14:15:22Z",
                "created_at": "2019-08-24T14:15:22Z"
            }
        ],
        "meta": {}
    }
}

🟠404Record Not Found