User Extra

Endpoints Summary

Method	Path	Swagger
GET	/user_extra/	Swagger ↗
POST	/user_extra/	Swagger ↗
GET	/user_extra/{id}/	Swagger ↗
PUT	/user_extra/{id}/	Swagger ↗
PATCH	/user_extra/{id}/	Swagger ↗
DELETE	/user_extra/{id}/	Swagger ↗

---

The User Extra API endpoints allow you to manage additional user information and extended profile informationdata beyondin basic account details.GATE. These endpoints handle extendedsupplementary user attributes like demographics, contact information,details, locationcustom data,fields, and customprofile fieldsmetadata that extend beyond basic user account information. Use these endpoints to store and retrieve comprehensive user profiles for enhanced userpersonalization profiles.and data collection.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The User Extra API provides comprehensive management of extended user profile information in GATE. This category handles supplementary user informationdata that extendsgoes beyond standard userbasic account data.credentials, Thisincluding APIdemographic categoryinformation, iscontact designeddetails, location data, custom fields, and business-related attributes.

These endpoints are essential for organizations that need to handlecollect and manage detailed user profiles includingfor compliance, personalization, reporting, or customer relationship management purposes. The API supports flexible data collection through eight custom fields, standard demographic information, geographic data, contact details,fields, and customizablebusiness-specific fields.information like tax IDs and passport numbers.

Key Features:

Demographic Management: HandleThe user gender,extra agedata ranges,is linked to parent user accounts through the parent field, allowing you to maintain a clear relationship between core user accounts and birthdaytheir informationextended profile Geographicinformation. Data:This Storeseparation enables you to manage sensitive or optional profile data independently from essential authentication details.

Common scenarios include user registration flows that collect additional profile information, compliance requirements for identity verification, demographic data collection for analytics, and managecustom location information including address, city, state, country, and hometown

Contact Information: Manage telephone numbers and other communication details Custom Fields: Eight configurable customdata fields for organization-specific data Business Information: Support for company, title, and tax identification details Document Management: Handle passport numbers and country identification

Common Integration Scenarios:

User onboarding workflows requiring detailed profile completion Customer relationship management systems needing extended user data Event registration systems collecting participant information Compliance systems requiring user verification and documentation Marketing platforms utilizing demographic and geographic targeting

The API follows RESTful principles with full CRUD operations, supporting both complete updates (PUT) and partial modifications (PATCH) for flexible data management.needs.

---

Endpoints

GET /user_extra/

Description: RetrievesRetrieve a paginated list of user extra information records. This endpoint supportsallows you to fetch multiple user profiles with optional filtering by parent user andor organization,organization. makingUse it idealthis for bulk data retrievalretrieval, andreporting, or administrative dashboards.dashboards where you need to view multiple user profiles simultaneously.

Use Cases:

• Generate user demographic reports for analytics

Export user profile data for compliance audits Administrative dashboards displaying user profile completion status Data export operations for reporting and analyticsinformation Bulk user data synchronization with external systems Organization-wide user profile auditing

Full URL Example:

https://gate.zequenze.com/api/v1/user_extra/?parent__organization_id=123&limit=50&device_info=true

Parameters:

Parameter	Type	In	Required	Description
parent	string	query	No	Filter by specific parent user ID to get extra info for specific user
parent__organization_id	string	query	No	Filter by organization ID ofto theget parentall user extra info within an organization
limit	integer	query	No	Number of results to return per page (default:default systempagination configured)applies)
offset	integer	query	No	StartingThe initial index from which to return the results for pagination
device_info	boolean	query	No	Include additional device information in the response

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/user_extra/?parent__organization_id=123&limit=25&offset=0" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 150,
  "next": "https://gate.zequenze.com/api/v1/user_extra/?limit=25&offset=25",
  "previous": null,
  "results": [
    {
      "id": 1,
      "parent": 45,456,
      "gender"title": "f"Dr.",
      "age_range"company": "25-34"Acme Corporation",
      "age": 28,
      "birthday"telephone": "1995-06-15",
      "locale": "en_US"+1-555-0123",
      "address": "123 Main Street, Apt 4B",
      "hometown": "Springfield"Street",
      "city": "NewSan York"Francisco",
      "state": "NY"CA",
      "postal_code": "94105",
      "country": "United States",
      "location"country_id": "40.7128,-74.0060"US",
      "telephone": "+1-555-123-4567",
      "accept_terms": true
    },
    {
      "id": 2,
      "parent": 67,
      "gender": "m"f",
      "birthday": "1985-03-15",
      "age": 39,
      "age_range": "35-44",
      "age": 38,
      "birthday": "1985-03-22",
      "locale": "en_GB"en_US",
      "address"location": "456San OakFrancisco, Avenue"CA",
      "hometown": "Manchester",Portland, "city": "London",
      "state": "England",
      "country": "United Kingdom",
      "location": "51.5074,-0.1278",
      "telephone": "+44-20-7123-4567"OR",
      "accept_terms": truetrue,
      "custom_field_1": "Premium Member",
      "custom_field_2": "Referred by John Smith",
      "event": "Conference 2024",
      "tax_id": "12-3456789",
      "passport_number": null
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns paginated list of user extra recordsinformation
401	Unauthorized - Invalid or missing authentication token
403	Forbidden - Insufficient permissions to access user data

---

POST /user_extra/

Description: Creates aCreate new user extra information record.record for a specific parent user. This endpoint acceptsallows you to add comprehensive user profile data includingwhen demographics,users location,register contactor information,when andadditional custominformation needs to be collected. All fields forexcept organization-specificthe requirements.parent user ID are optional, providing flexibility in data collection workflows.

Use Cases:

• UserComplete user registration completionwith workflowsextended profile information
• ProfileAdd enhancementdemographic data during user onboarding
• EventCollect compliance-required information for identity verification

Store event-specific user data during registration with detailed participant information Customer data collection for CRM systemsprocesses

Full URL Example:

https://gate.zequenze.com/api/v1/user_extra/

Request Body Parameters:

Field Type Required Description parent integer Yes ID of the parent user account gender string No Gender identifier (m/f/o for male/female/other) age_range string No Age category for demographic analysis age integer No Specific age value birthday string (date) No Birth date in YYYY-MM-DD format locale string No User's preferred locale/language setting address string No Complete street address city string No City of residence state string No State or province postal_code string No ZIP or postal code country string No Country name or code telephone string No Primary phone number company string No Employer or company name title string No Job title or position accept_terms boolean No Terms and conditions acceptance status

cURL Example:

curl -X POST "https://gate.zequenze.com/api/v1/user_extra/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "parent": 45,789,
    "gender"title": "f"Ms.",
    "age": 28,
    "birthday"company": "1995-06-15"Tech Innovations LLC",
    "locale"telephone": "en_US"+1-555-0456",
    "address": "123456 MainInnovation Street, Apt 4B"Drive",
    "city": "New York"Austin",
    "state": "NY"TX",
    "postal_code": "10001"73301",
    "country": "United States",
    "telephone"country_id": "+1-555-123-4567"US",
    "company"gender": "Tech Solutions Inc"f",
    "title"birthday": "Software1992-07-22",
    Engineer""locale": "en_US",
    "accept_terms": true,
    "custom_field_1": "Department:Marketing Engineering"Campaign A",
    "custom_field_2": "EmployeeEnterprise ID:Tier",
    ENG001""event": "Product Launch 2024"
  }'

Example Response:

{
  "id": 1,25,
  "gender"parent": 789,
  "title": "f"Ms.",
  "age_range": null,
  "age": 28,
  "birthday"company": "1995-06-15"Tech Innovations LLC",
  "locale"telephone": "en_US"+1-555-0456",
  "address": "123456 MainInnovation Street, Apt 4B"Drive",
  "hometown": null,
  "city": "New York"Austin",
  "state": "NY"TX",
  "postal_code": "10001"73301",
  "country": "United States",
  "country_id": "US",
  "gender": "f",
  "birthday": "1992-07-22",
  "age": 32,
  "age_range": "25-34",
  "locale": "en_US",
  "location": null,"Austin, "telephone": "+1-555-123-4567"TX",
  "company": "Tech Solutions Inc",
  "title": "Software Engineer",
  "passport_number": null,
  "country_id": null,
  "tax_id": null,
  "event"hometown": null,
  "accept_terms": true,
  "custom_field_1": "Department:Marketing Engineering"Campaign A",
  "custom_field_2": "EmployeeEnterprise ID: ENG001"Tier",
  "custom_field_3": null,
  "custom_field_4": null,
  "custom_field_5": null,
  "custom_field_6": null,
  "custom_field_7": null,
  "custom_field_8": null,
  "event": "Product Launch 2024",
  "tax_id": null,
  "passport_number": null
}

Response Codes:

Status	Description
201	Created - User extra recordinformation successfully created
400	Bad Request - Invalid data format or missing required fieldsparent field
401	Unauthorized - Invalid or missing authentication token
409	Conflict - User extra recordinformation already exists for this parent user

---

GET /user_extra/{id}/

Description: RetrievesRetrieve detailed user extra information for a specific user extra record by ID. This endpoint providesreturns completecomprehensive accessprofile todata allfor storeda additionalsingle user extra record, including optional device information andwhen optionallyrequested. includesUse device-relatedthis data.for displaying detailed user profiles or retrieving specific user data for processing.

Use Cases:

• UserDisplay complete user profile displayin pagesadmin interfaces
• ProfileRetrieve editinguser information for customer service interactions

Load user data for form pre-population during updates UserAccess datauser verificationdetails processes Individual record auditing andfor compliance checksor audit purposes

Full URL Example:

https://gate.zequenze.com/api/v1/user_extra/1/25/?device_info=true

Parameters:

Parameter	Type	In	Required	Description
id	integer	path	Yes	UniqueThe unique identifier of the user extra record to retrieve
device_info	boolean	query	No	Include additional device information in the response

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/user_extra/1/?device_info=true"25/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "id": 1,25,
  "parent": 45,789,
  "gender"title": "f"Ms.",
  "age_range"company": "25-34"Tech Innovations LLC",
  "age": 28,
  "birthday"telephone": "1995-06-15",
  "locale": "en_US"+1-555-0456",
  "address": "123456 MainInnovation Street, Apt 4B",
  "hometown": "Springfield"Drive",
  "city": "New York"Austin",
  "state": "NY"TX",
  "postal_code": "73301",
  "country": "United States",
  "country_id": "US",
  "gender": "f",
  "birthday": "1992-07-22",
  "age": 32,
  "age_range": "25-34",
  "locale": "en_US",
  "location": "40.7128,-74.0060"Austin, TX",
  "telephone"hometown": "+1-555-123-4567"Dallas, TX",
  "accept_terms": truetrue,
  "custom_field_1": "Marketing Campaign A",
  "custom_field_2": "Enterprise Tier",
  "custom_field_3": "Preferred Contact: Email",
  "custom_field_4": null,
  "custom_field_5": null,
  "custom_field_6": null,
  "custom_field_7": null,
  "custom_field_8": null,
  "event": "Product Launch 2024",
  "tax_id": "75-1234567",
  "passport_number": null
}

Response Codes:

Status	Description
200	Success - Returns the requested user extra recordinformation
401	Unauthorized - Invalid or missing authentication token
404	Not Found - User extra record with specified ID does not exist
403	Forbidden - Insufficient permissions to access this recorduser's data

---

PUT /user_extra/{id}/

Description: Completely updatesupdate an existing user extra recordinformation with new data.record. This endpoint requiresreplaces all fields toof the user extra record with the provided data. Any fields not included in the request will be providedcleared (set to null), except for the ID and replacesparent thefields. entireUse record, making it idealthis for complete profile updates andwhere datayou synchronization.want to replace all existing information.

Use Cases:

• Complete profile updates from user settings pages
• Data synchronization from external systems

Profile migration or data correction workflows Bulk databulk updates with completefull record replacement Compliance updates that require complete information refresh Administrative corrections that involve multiple fields

Full URL Example:

https://gate.zequenze.com/api/v1/user_extra/1/25/

cURL Example:

curl -X PUT "https://gate.zequenze.com/api/v1/user_extra/1/25/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "gender"parent": 789,
    "title": "f"Dr.",
    "age": 29,
    "birthday"company": "1995-06-15"Tech Innovations LLC",
    "locale"telephone": "en_US"+1-555-0789",
    "address": "456789 NewUpdated Street, Suite 2A"Street",
    "city": "New York"Austin",
    "state": "NY"TX",
    "postal_code": "10002"73301",
    "country": "United States",
    "telephone"country_id": "+1-555-987-6543"US",
    "company"gender": "Advanced Tech Corp"f",
    "title"birthday": "Senior1992-07-22",
    Software"locale": Engineer""en_US",
    "accept_terms": true,
    "custom_field_1": "Department:Updated SeniorMarketing Engineering"Campaign",
    "custom_field_2": "EmployeePremium ID: SEN001"Enterprise",
    "custom_field_3": "Team:VIP BackendCustomer",
    Development""event": "Annual Conference 2024"
  }'

Example Response:

{
  "id": 1,25,
  "gender"parent": 789,
  "title": "f"Dr.",
  "age_range": null,
  "age": 29,
  "birthday"company": "1995-06-15"Tech Innovations LLC",
  "locale"telephone": "en_US"+1-555-0789",
  "address": "456789 NewUpdated Street, Suite 2A"Street",
  "hometown": null,
  "city": "New York"Austin",
  "state": "NY"TX",
  "postal_code": "10002"73301",
  "country": "United States",
  "country_id": "US",
  "gender": "f",
  "birthday": "1992-07-22",
  "age": 32,
  "age_range": "25-34",
  "locale": "en_US",
  "location": null,"Austin, "telephone": "+1-555-987-6543"TX",
  "company": "Advanced Tech Corp",
  "title": "Senior Software Engineer",
  "passport_number": null,
  "country_id": null,
  "tax_id": null,
  "event"hometown": null,
  "accept_terms": true,
  "custom_field_1": "Department:Updated SeniorMarketing Engineering"Campaign",
  "custom_field_2": "EmployeePremium ID: SEN001"Enterprise",
  "custom_field_3": "Team:VIP Backend Development"Customer",
  "custom_field_4": null,
  "custom_field_5": null,
  "custom_field_6": null,
  "custom_field_7": null,
  "custom_field_8": null,
  "event": "Annual Conference 2024",
  "tax_id": null,
  "passport_number": null
}

Response Codes:

Status	Description
200	Success - User extra recordinformation successfully updated
400	Bad Request - Invalid data format or validation errors
401	Unauthorized - Invalid or missing authentication token
404	Not Found - User extra record with specified ID does not exist
403	Forbidden - Insufficient permissions to modify this recorduser's data

---

PATCH /user_extra/{id}/

Description: Partially updatesupdate specific fields inof an existing user extra information record. This endpoint allows selectiveyou fieldto modify only the fields you specify, leaving all other fields unchanged. This is ideal for targeted updates like changing a phone number, updating custom fields, or modifying specific demographic information without affecting otherthe storedrest data,of makingthe it efficient for individual field modifications and incremental updates.profile.

Use Cases:

• SingleUpdate fieldspecific profile fields like phone number or address

Modify custom fields for campaign tracking or user segmentation Partial updates from userforms interfacesthat only collect certain information ProgressiveIncremental profile completion workflowsover Targetedmultiple data corrections Event-driven field updates from external triggersinteractions

Full URL Example:

https://gate.zequenze.com/api/v1/user_extra/1/25/

cURL Example:

curl -X PATCH "https://gate.zequenze.com/api/v1/user_extra/1/25/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "telephone": "+1-555-111-2222"9999",
    "title"custom_field_4": "LeadNewsletter Software Engineer"Subscriber",
    "custom_field_3"tax_id": "Team: Full Stack Development"75-9876543"
  }'

Example Response:

{
  "id": 1,25,
  "gender"parent": 789,
  "title": "f"Dr.",
  "age_range": null,
  "age": 29,
  "birthday"company": "1995-06-15"Tech Innovations LLC",
  "locale"telephone": "en_US"+1-555-9999",
  "address": "456789 NewUpdated Street, Suite 2A"Street",
  "hometown": null,
  "city": "New York"Austin",
  "state": "NY"TX",
  "postal_code": "10002"73301",
  "country": "United States",
  "country_id": "US",
  "gender": "f",
  "birthday": "1992-07-22",
  "age": 32,
  "age_range": "25-34",
  "locale": "en_US",
  "location": null,"Austin, "telephone": "+1-555-111-2222"TX",
  "company": "Advanced Tech Corp",
  "title": "Lead Software Engineer",
  "passport_number": null,
  "country_id": null,
  "tax_id": null,
  "event"hometown": null,
  "accept_terms": true,
  "custom_field_1": "Department:Updated SeniorMarketing Engineering"Campaign",
  "custom_field_2": "EmployeePremium ID: SEN001"Enterprise",
  "custom_field_3": "Team:VIP Full Stack Development"Customer",
  "custom_field_4": null,"Newsletter Subscriber",
  "custom_field_5": null,
  "custom_field_6": null,
  "custom_field_7": null,
  "custom_field_8": null,
  "event": "Annual Conference 2024",
  "tax_id": "75-9876543",
  "passport_number": null
}

Response Codes:

Status	Description
200	Success - User extra recordinformation successfullypartially updated
400	Bad Request - Invalid data format or validation errors
401	Unauthorized - Invalid or missing authentication token
404	Not Found - User extra record with specified ID does not exist
403	Forbidden - Insufficient permissions to modify this recorduser's data

---

DELETE /user_extra/{id}/

Description: Permanently removesdelete a user extra information recordrecord. fromThis endpoint removes all extended profile data for the system.specified Thisrecord operationwhile cannotleaving bethe undone and should be used with caution, typically in data cleanup scenarios orparent user account deletionintact. workflows.Use this carefully as the operation is irreversible and will permanently remove all custom fields, demographic data, and additional profile information.

Use Cases:

• User account deletion processes

Data cleanup and privacy compliance (GDPR/CCPA)right to be forgotten requests) DuplicateClean recordup removaltest or invalid user extra records Remove profile data when users downgrade to basic accounts Administrative datacleanup managementof orphaned or duplicate records

Full URL Example:

https://gate.zequenze.com/api/v1/user_extra/1/25/

Parameters:

Parameter Type In Required Description id integer path Yes Unique identifier of the user extra record to delete

cURL Example:

curl -X DELETE "https://gate.zequenze.com/api/v1/user_extra/1/25/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response Codes:

Status	Description
204	No Content - User extra recordinformation successfully deleted
401	Unauthorized - Invalid or missing authentication token
404	Not Found - User extra record with specified ID does not exist
403	Forbidden - Insufficient permissions to delete this recorduser's data

---

Common Use Cases

Use Case 1: Complete User OnboardingRegistration WorkflowFlow

ImplementWhen aimplementing multi-step registration process where basiccomprehensive user accountsregistration, are created first, then enhanced with detailed profile information usinguse POST /user_extra/. Useafter PATCHcreating the base user account to collect additional profile information like demographics, company details, and custom tracking data for progressivemarketing profileor completioncompliance as users provide additional information over time.purposes.

Use Case 2: OrganizationCustomer UserProfile Management Dashboard

Build administrative interfaces using GET /user_extra/ with organization filtering to display user profileprofiles, completionthen status,use demographicindividual analytics,GET and/user_extra/{id}/ datacalls qualityto metricsshow acrossdetailed theinformation organization.when administrators need to view or assist specific users.

Use Case 3: EventProgressive RegistrationProfile SystemCompletion

CollectImplement comprehensiveprogressive attendeeprofile informationbuilding during event registrationby using POSTPATCH /user_extra/{id}/ to incrementally add information as users interact with your system, updating custom fields forto event-specifictrack data like dietary restrictions, accommodationengagement, preferences, andor specialadditional requirements.voluntary information over time.

Use Case 4: CRM Integration and Data Synchronization

Synchronize customer data between external CRM systems using PUT /user_extra/{id}/ for complete record updates and PATCH for incremental changes triggered by external system events.

Use Case 5: Compliance and Data Privacy Management

ImplementUse GDPR/CCPA compliance workflows usingthe DELETE /user_extra/{id}/ endpoint to handle right-to-be-forgotten requests while maintaining core user accounts, or use PUT operations to update compliance-related fields like tax IDs and passport numbers for identity verification.

Use Case 5: Event-Based Data Collection

During events, conferences, or campaigns, create user extra records with event-specific information in the event field and custom fields, then use filtering by organization or event data removalto requestsgenerate attendee reports and GET operations for data export and audit trail requirements.analytics.

---

Best Practices

• PaginationUse Strategy:PATCH for targeted updates: AlwaysWhen updating specific fields like contact information or custom fields, use appropriatePATCH limitinstead andof offsetPUT valuesto whenavoid retrievingaccidentally largeclearing datasets.other Startprofile with smaller page sizes (25-50 records) and adjust based on performance requirements.data.

• IncrementalImplement Updates:proper validation: PreferAlways PATCHvalidate over PUT for singlegender field updates to minimize bandwidth usage and reduce the risk of data conflicts in concurrent environments.

Data Validation: Validate gender values ('m',m, 'f',f, 'o')o) and date formats (YYYY-MM-DD) on the client side before submissionsending requests to preventavoid validation400 errors.

CustomHandle Fieldspagination Management:efficiently: EstablishFor clearlarge namingdatasets, conventionsuse forreasonable customlimit fieldsvalues within(25-100 yourrecords) organizationand implement offset-based pagination to ensureavoid consistencytimeouts and maintainabilityimprove across different integrations.performance.

ErrorSecure Handling:sensitive data: Be particularly careful with fields like tax_id and passport_number - ensure these are only accessible to authorized personnel and consider encryption at rest.

Use device_info parameter judiciously: Only request device information when necessary as it adds processing overhead and response size.

Implement robustproper error handling: Always check for 404 responses when accessing recordsspecific thatrecords, as user extra data may have beenbe deleted byindependently otherof processes,parent anduser 403 responses for authorization issues.accounts.

GeographicLeverage Data:custom fields strategically: UsePlan your custom field usage in advance - use consistent country naming conventions and considerdocument implementingwhat countryeach codecustom validationfield to ensure data quality for location-based features.

Performance Optimization: Use the device_info parameter only when necessary, as it may impact response times for large datasets.

Security Considerations: Always validate user permissions before allowing access to user extra data, especiallyrepresents in multi-tenantyour environments with organization-based access controls.application.

---