Skip to main content

Customer Registrations - Brij API Endpoint

Overview

Use the Customer Registrations API to list registrations with pagination. Responses include registration metadata, warranty timing, status, and core customer contact details so you can power post-purchase workflows and lifecycle analytics.

  • Method: GET

  • URL: https://{{Base_URL}}/customers/registrations

    • Ask your account manager for the full URL

  • Auth: API-KEY: <your key> (header)

Benefits

  • Check if a customer exists in Brij

  • Surface registration status and warranty windows for customer support.

  • Feed CRM/CDP with clean, paged records of customer data.

  • Enable dashboards that track registration volume and methods.

How to Use

Using this API is similar to exporting the customer data you would find on the Customer Registrations page within Brij.

  1. Call the endpoint with pagination parameters & optional filtering:

    • limit (integer, required): max records per page (e.g., 100)

    • page (integer, required): page index (e.g., 1)

    • emails (string, optional): one or multiple emails to search as a comma separated list

      • example: emails=info@brij.it

      • example: emails=info@brij.it,demo@brij.it

        • which is actually sent as: emails=info%40brij.it%2C%20demo%40brij.it

    • phones (string): one or multiple phone numbers to search as a comma separated list. Always include the country code without the +.

      • example: phones=16198675309

      • example: phones=1619

        • this will return numbers within this area code. you can do the first parts of a number but only if the beginning is included. phones=5309 will not return the above results using this parameter, use the 'search' parameter for partial matches of the end of a phone number instead.

    • search (string, optional): a search term to find possible matches using either email or phone numbers, including partial matches like "jane".

      • example: search=john@

      • example: search=619

    • createdFrom (string, optional): To search for registrations created within a certain time period, use these date parameters. This filters using the Registration Initiation Date, which is when the customer submitted their email to begin the registration flow.

      • example: createdFrom=2025-10-01

      • example: createdFrom=2025-10-01T11:03:14.482-06:00

      • example: createdFrom=2025-10-01T17:03:14.482Z

        • which is actually sent as: 2025-10-01T17%3A03%3A14.482Z

    • createdTo (string, optional): end date of the time period being filtered

      • example: createdTo=2025-12-31

    • approvedFrom (string, optional): To search for registrations approved within a certain time period, use these date parameters. This filters using the Registration Approval Date, which is when the brand admin approved the customer registration, completing the entire process. Remember, most registrations are set to auto-approve, so this will be the same date the customer submitted the registration.

      • example: approvedFrom=2025-10-01T17:03:14.482Z

        • which is actually sent as: 2025-10-01T17%3A03%3A14.482Z

    • approveTo (string, optional): end date of the time period being filtered

      • example: approvedTo=2025-12-31

  2. Include your API key in the API-KEY header.

    1. API keys can be created within Brij by going to Settings > Integrations and scrolling to the bottom of the page. This feature is not included in all plans, please speak with your Account Manager to enable it.

  1. Parse the response:

    • data: array of registration objects

    • limit: echo of your requested limit

    • pageInfo: pagination metadata

    • returnedCount: number of records in this page

Response fields (high-level)

On a successful request, the API will return a JSON response with the following structure:

  • data (array): An array containing registration objects, each with the following fields:
    • Registration ID: Unique identifier for each registration.
    • Registration Initiation Date: Date when the registration was created, meaning the email was submitted.
    • Registration Method: Method used for registration. Users may log in using Google authentication.
    • Registration Warranty Duration: Duration of the warranty associated with the registration. This is determined in the warranty module setup.
    • Registration Expiry Date: Expiry date of the registration.
    • Registration Status: Current status of the registration. Approved or Expired.
    • Customer Email: Email address of the customer. This is required to create a registration and trigger an initiation event. Registration may require more fields to be completed depending on experience configuration.
    • Customer Phone Number: Phone number of the customer. Optionally collected using "Complete Profile", "Purchase Details", or a Form Module per the experience registration step configuration.
    • Additional fields related to customer preferences, device information, and experience details. 
      • See Below.

Example (cURL)

curl --location 'https://{{Base_URL}}/customers/registrations?limit=100&page=1&email=info%40brij.it' \
  --header 'API-KEY: {{API-KEY}}'

Example Response

{
   "data": [
       {
           "Registration ID": "Edv6AqBqtSVZ",
           "Registration Initiation Date": "October 23, 2025 at 20:12 UTC",
           "Registration Submission Date": "October 23, 2025 at 20:12 UTC",
           "Registration Approval Date": "",
           "Registration Method": "google.com",
           "Registration Warranty Duration": "1 Months",
           "Registration Expiry Date": "November 23, 2025 at 20:12 UTC",
           "Registration Extended Warranty Id": "",
           "Registration Extended Warranty Duration": "",
           "Registration Extended Warranty Provider": "",
           "Registration Status": "expired",
           "Registration Module Name": "Registration TEST Module",
           "Registration Discount Code": "",
           "Registration Purchase Date": "",
           "Registration Purchase Quantity": "",
           "Registration Purchase Channel": "",
           "Registration Purchase Receipt": "",
           "Registration Serial Number": "",
           "Rating": "",
           "Registration Note": "",
           "Customer Retail Channel": "Walmart",
           "Customer IP": "123.45.678.90",
           "Customer Email": "info@brij.it",
           "Customer Phone Number": "+16198675309",
           "Customer First Name": "Bad",
           "Customer Last Name": "Bunny",
           "Customer Source": "",
           "Customer Email Consent": true,
           "Customer SMS Single Consent": true,
           "Customer Cookie Consent (All Cookies)": true,
           "Customer Functional Cookie Consent": true,
           "Customer Analytics Cookie Consent": true,
           "Customer Marketing Cookie Consent": true,
           "Customer Address": "",
           "Customer Address Line 1": "",
           "Customer Address Line 2": "",
           "Customer Address City": "",
           "Customer Address State": "",
           "Customer Address Zip": "",
           "Customer Address Country": "",
           "Customer DOB": "",
           "Location Country": "US",
           "Location City": "Farmington",
           "Location State": "New Mexico",
           "Location Zip": "87401",
           "Location Latitude": -108.21869,
           "Location Longitude": 36.72806,
           "Location Type": "ip address",
           "Experience Type": "Product Experience",
           "Experience Name": "WebApp TEST",
           "Experience Title": "Try this WebApp",
           "Experience Subtitle": "...it's great",
           "Experience URL": "https://brij.it/c/ABCD",
           "Experience Product or SKU Number": "40039",
           "Experience Description": "Product Description - desktop view is on",
           "Experience Image": "https://v2.brij.it/optimized-videos/Sgqyegsf7MH92xFjc/video-vp9-720p.webm",
           "Experience Brij ID": "ABCD",
           "Experience Serial Number": "",
           "Experience Lot Number": "",
           "Experience Product Price": "",
           "Experience Currency": "USD",
           "Device Name": "Apple Macintosh",
           "Device Type": "Desktop",
           "Device Browser": "Chrome 141.0.0.0",
           "Device Language": "en-US",
           "Device OS": "Mac OS 10.15.7",
           "Device Screen Resolution": "1920x1080",
           "New Email Subscriber": "Unknown",
           "New SMS Subscriber": "Unknown",
           "New Web Visitor": "Unknown"
       }
   ],
   "limit": 100,
   "pageInfo": "Page 1 of 1",
   "returnedCount": 1
}

FAQ & Troubleshooting

What does returnedCount mean?

  • It’s the number of items returned in the current page (can be less than limit).

Which fields are guaranteed?

  • Field presence can vary by registration, as data collection is configurable per experience in Brij; always code defensively for optional fields.

  • If no records are found, the response will besimilar to below

    • {
"data": [],
"limit": 100,
"pageInfo": "Page 1 of 0",
"returnedCount": 0
}

How do I get all registrations?

  • Iterate page until returnedCount is 0 (or less than your limit).

Related to

Updated

Was this article helpful?

0 out of 0 found this helpful

Related articles