Search contacts

Search for contacts using specific criteria. This endpoint allows you to find contacts by their unique identifiers: external ID, email, or document number. At least one of these three fields is required.

GET /contacts

cURL

cURL

curl --request GET \
  --url https://app.masivo.ai/api/storefront/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[e-mail]",
      "document_type": "<string>",
      "document_number": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "first_name": "<string>",
      "second_name": "<string>",
      "last_name": "<string>",
      "second_last_name": "<string>",
      "email_verified": false,
      "dob": "2023-12-25",
      "country": "<string>",
      "city": "<string>",
      "phone": "<string>",
      "is_anonymous": false,
      "source": "<string>",
      "channel": "<string>",
      "phone_verified": false,
      "status": "ACTIVE",
      "tags": {},
      "addresses": [
        {
          "street_1": "<string>",
          "street_2": "<string>",
          "street_number": "<string>",
          "reference": "<string>",
          "alias": "<string>",
          "zip_code": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>"
        }
      ],
      "billing_info": [
        {
          "document_number": "<string>",
          "document_type": "<string>",
          "legal_name": "<string>",
          "alias": "<string>",
          "street_1": "<string>",
          "street_2": "<string>",
          "street_number": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zip_code": "<string>",
          "phone": "<string>",
          "email": "<string>"
        }
      ],
      "payments": [
        {
          "last_four": "<string>",
          "card_holder": "<string>",
          "card_brand": "<string>",
          "alias": "<string>",
          "expiry_month": 123,
          "expiry_year": 123
        }
      ],
      "data": {
        "contact": {},
        "order": {
          "purchase_id": "<string>",
          "value": 20.95,
          "discounted_value": 10.95,
          "products": [
            {
              "sku": "<string>",
              "amount": 123,
              "value": 123,
              "discounted_value": 123,
              "redeem": [
                {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "amount": 1
                }
              ],
              "tags": {},
              "metadata": {}
            }
          ],
          "channel_id": "<string>",
          "store_id": "<string>",
          "shipping": {
            "value": 3.25,
            "discounted_value": 2.25,
            "redeem": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "amount": 1
              }
            ],
            "tags": {},
            "metadata": {}
          },
          "redeem": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "amount": 1
            }
          ],
          "metadata": {},
          "brand_id": "<string>"
        },
        "identity_resolutions": [
          {
            "conditions": "<array>",
            "max_group_size": 123,
            "temporal_limits": "<array>",
            "description": "<string>",
            "isDefault": true
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Headers

x-account-id · string<uuid> · required

Your account ID

Query Parameters

email · string<email>

Contact email address

document_number · string

Document number

external_id · string

External contact ID

second_last_name · string

Second last name

dob · string<date>

Date of birth

persona_id · string<uuid>

Persona ID for unified contacts

phone · string

Contact phone number

gender · string

Contact gender

document_type · string

Contact document type

first_name · string

Contact first name

last_name · string

Contact last name

country · string

Contact country

city · string

Contact city

source · string

Contact source

channel · string

Contact channel

Response

200

application/json

Ok

data · object[]

Show child attributes