Skip to main content

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 providesendpoints comprehensiveallow managementyou ofto extendedmanage additional user profile information beyond basic account details. These endpoints allowhandle youextended touser storeattributes andlike retrievedemographics, additionalcontact demographic,information, contact,location data, and custom datafields for users, supporting detailedenhanced user profiling for analytics, personalization, and compliance requirements.profiles.

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 enablesprovides organizationscomprehensive tomanagement collect and manageof supplementary user information that extends beyond standard user accounts.account data. This includesAPI category is designed to handle detailed user profiles including demographic datainformation, (gender,geographic age, location),data, contact information (address, telephone), business details (company, title), identification data (passport numbers, tax IDs),details, and flexiblecustomizable fields.

Key Features:

    Demographic Management: Handle user gender, age ranges, and birthday information Geographic Data: Store and manage location information including address, city, state, country, and hometown Contact Information: Manage telephone numbers and other communication details Custom Fields: Eight configurable custom fields for organization-specific requirements.data Business Information: Support for company, title, and tax identification details Document Management: Handle passport numbers and country identification

    Common useIntegration cases include:Scenarios:

    • User Analyticsonboarding &workflows Segmentation:requiring Collectdetailed 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 data for user behavior analysis and targetedgeographic campaigns Event Registration: Gather additional attendee information for conferences, webinars, or corporate events Compliance & KYC: Store identification and verification data for regulated industries Personalization: Use location and preference data to customize user experiences Custom Data Collection: Utilize flexible custom fields for organization-specific information gatheringtargeting

    TheseThe endpointsAPI workfollows togetherRESTful toprinciples providewith full CRUD operationsoperations, onsupporting userboth extracomplete data,updates with list filtering capabilities(PUT) and optionalpartial devicemodifications information inclusion(PATCH) for comprehensiveflexible userdata profiling.management.

    Endpoints

    GET /user_extra/

    Description: Retrieves a paginated list of all user extra information records. This endpoint is essential for viewing collected user data across your organization, withsupports filtering options to narrow results by parent user orand organization.organization, making it ideal for bulk data retrieval and administrative dashboards.

    Use Cases:

    • GenerateAdministrative dashboards displaying user demographicprofile reportscompletion status
    Data export operations for reporting and analytics ExportBulk user data forsynchronization compliancewith auditingexternal systems FilterOrganization-wide usersuser byprofile organization for multi-tenant applicationsauditing

    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 specific user's extra data
    parent__organization_id string query No Filter by organization ID toof getthe allparent users within an organizationuser
    limit integer query No Number of results to return per page (defaultdefault: paginationsystem applies)configured)
    offset integer query No The initialStarting index from which to return results for pagination
    device_info boolean query No Include additional device information in the response for enhanced user profiling

    cURL Example:

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

    Example Response:

    {
  "count": 156,150,
  "next": "https://gate.zequenze.com/api/v1/user_extra/?limit=2025&offset=20&parent__organization_id=123"25",
  "previous": null,
  "results": [
    {
      "id": 42,1,
      "parent": 1001,45,
      "gender": "f",
      "age_range": "25-34",
      "age": 28,
      "birthday": "1995-06-15",
      "locale": "en-US"en_US",
      "address": "123 Main Street, SuiteApt 100"4B",
      "hometown": "Springfield",
      "city": "Chicago"New York",
      "state": "Illinois"NY",
      "country": "United States",
      "location": "Chicago, IL, USA"40.7128,-74.0060",
      "telephone": "+1-555-123-4567",
      "accept_terms": true
    },
    {
      "id": 2,
      "parent": 67,
      "gender": "m",
      "age_range": "35-44",
      "age": 38,
      "birthday": "1985-03-22",
      "locale": "en_GB",
      "address": "456 Oak Avenue",
      "hometown": "Manchester",
      "city": "London",
      "state": "England",
      "country": "United Kingdom",
      "location": "51.5074,-0.1278",
      "telephone": "+44-20-7123-4567",
      "accept_terms": true
    }
  ]
}

    Response Codes:

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

    POST /user_extra/

    Description: Creates a new extended user extra information records.record. This endpoint isaccepts typically used duringcomprehensive user onboarding, event registration, or when collecting additional profile data fromincluding existingdemographics, users.location, contact information, and custom fields for organization-specific requirements.

    Use Cases:

    • CollectUser additionalregistration usercompletion informationworkflows
    Profile enhancement during registration flowsonboarding StoreEvent eventregistration attendeewith detailsdetailed participant information Customer data collection for conferencesCRM or webinars Capture compliance data for regulated industriessystems

    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": 1001,45,
    "gender": "m"f",
    "age": 32,28,
    "birthday": "1991-03-22"1995-06-15",
    "locale": "en_US",
    "address": "123 Main Street, Apt 4B",
    "city": "SanNew Francisco"York",
    "state": "California"NY",
    "postal_code": "10001",
    "country": "United States",
    "telephone": "+1-555-987-6543"123-4567",
    "company": "Tech InnovationsSolutions Inc",
    "title": "SeniorSoftware Developer"Engineer",
    "accept_terms": true,
    "custom_field_1": "PremiumDepartment: Member"Engineering",
    "custom_field_2": "AnnualEmployee Subscription"ID: ENG001"
  }'

    Example Response:

    {
  "id": 43,1,
  "gender": "m"f",
  "age_range": null,
  "age": 32,28,
  "birthday": "1991-03-22"1995-06-15",
  "locale": null,"en_US",
  "address": null,"123 Main Street, Apt 4B",
  "hometown": null,
  "city": "SanNew Francisco"York",
  "state": "California"NY",
  "postal_code": null,"10001",
  "country": "United States",
  "location": null,
  "telephone": "+1-555-987-6543"123-4567",
  "company": "Tech InnovationsSolutions Inc",
  "title": "SeniorSoftware Developer"Engineer",
  "passport_number": null,
  "country_id": null,
  "tax_id": null,
  "event": null,
  "accept_terms": true,
  "custom_field_1": "PremiumDepartment: Member"Engineering",
  "custom_field_2": "AnnualEmployee Subscription"ID: ENG001",
  "custom_field_3": null,
  "custom_field_4": null,
  "custom_field_5": null,
  "custom_field_6": null,
  "custom_field_7": null,
  "custom_field_8": null
}

    Response Codes:

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

    GET /user_extra/{id}/

    Description: Retrieves detailed information for a specific user extra record by ID. This endpoint is useful for viewingprovides complete access to all stored additional user profiles, including optional device information forand comprehensiveoptionally userincludes analysis.device-related data.

    Use Cases:

    • DisplayUser detailedprofile userdisplay profiles in admin dashboardspages
    • RetrieveProfile specificediting userform pre-population
    User data forverification customer supportprocesses AccessIndividual userrecord informationauditing forand personalizationcompliance featureschecks

    Full URL Example:

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

    Parameters:

    Parameter Type In Required Description
    id integer path Yes Unique identifier of the user extra record
    device_info boolean query No Include additional device information forin enhanced user profilingresponse

    cURL Example:

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

    Example Response:

    {
  "id": 42,1,
  "parent": 1001,45,
  "gender": "f",
  "age_range": "25-34",
  "age": 28,
  "birthday": "1995-06-15",
  "locale": "en-US"en_US",
  "address": "123 Main Street, SuiteApt 100"4B",
  "hometown": "Springfield",
  "city": "Chicago"New York",
  "state": "Illinois"NY",
  "country": "United States",
  "location": "Chicago, IL, USA"40.7128,-74.0060",
  "telephone": "+1-555-123-4567",
  "accept_terms": true
}

    Response Codes:

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

    PUT /user_extra/{id}/

    Description: Completely updates an existing user extra record, replacing all fieldsrecord with new values.data. This endpoint requires all datafields to be provided and isreplaces the entire record, making it ideal for comprehensivecomplete profile updates.updates and data synchronization.

    Use Cases:

    • UpdateComplete completeprofile updates from user profilessettings after data verificationpages
    • SyncData user informationsynchronization from external systems
    • RefreshProfile allmigration useror data duringcorrection periodicworkflows
    Bulk data updates with complete record replacement

    Full URL Example:

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

    cURL Example:

    curl -X PUT "https://gate.zequenze.com/api/v1/user_extra/42/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "gender": "f",
    "age": 29,
    "birthday": "1995-06-15",
    "locale": "en-US"en_US",
    "address": "456 OakNew Avenue,Street, AptSuite 5B"2A",
    "city": "Chicago"New York",
    "state": "Illinois"NY",
    "postal_code": "60601"10002",
    "country": "United States",
    "telephone": "+1-555-123-4567"987-6543",
    "company": "DesignAdvanced SolutionsTech LLC"Corp",
    "title": "CreativeSenior Director"Software Engineer",
    "accept_terms": true,
    "custom_field_1": "EnterpriseDepartment: Client"Senior Engineering",
    "custom_field_2": "VIPEmployee Status"ID: SEN001",
    "custom_field_3": "Team: Backend Development"
  }'

    Example Response:

    {
  "id": 42,1,
  "gender": "f",
  "age_range": null,
  "age": 29,
  "birthday": "1995-06-15",
  "locale": "en-US"en_US",
  "address": "456 OakNew Avenue,Street, AptSuite 5B"2A",
  "hometown": null,
  "city": "Chicago"New York",
  "state": "Illinois"NY",
  "postal_code": "60601"10002",
  "country": "United States",
  "location": null,
  "telephone": "+1-555-123-4567"987-6543",
  "company": "DesignAdvanced SolutionsTech LLC"Corp",
  "title": "CreativeSenior Director"Software Engineer",
  "passport_number": null,
  "country_id": null,
  "tax_id": null,
  "event": null,
  "accept_terms": true,
  "custom_field_1": "EnterpriseDepartment: Client"Senior Engineering",
  "custom_field_2": "VIPEmployee Status"ID: SEN001",
  "custom_field_3": null,"Team: Backend Development",
  "custom_field_4": null,
  "custom_field_5": null,
  "custom_field_6": null,
  "custom_field_7": null,
  "custom_field_8": null
}

    Response Codes:

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

    PATCH /user_extra/{id}/

    Description: Partially updates specific fields ofin an existing user extra record. This endpoint allows selective field updates without affecting other stored data, making it perfectefficient for individual field modifications and incremental profile updates.

    Use Cases:

    • UpdateSingle specificfield user fields like contact information
    Modify custom fields without changing personal data Apply incremental changesupdates from user interfaces Progressive profile editscompletion workflows Targeted data corrections Event-driven field updates from external triggers

    Full URL Example:

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

    cURL Example:

    curl -X PATCH "https://gate.zequenze.com/api/v1/user_extra/42/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "telephone": "+1-555-999-8888"111-2222",
    "company"title": "NewLead CompanySoftware Name Inc"Engineer",
    "custom_field_1"custom_field_3": "UpdatedTeam: Status"Full Stack Development"
  }'

    Example Response:

    {
  "id": 42,1,
  "gender": "f",
  "age_range": null,
  "age": 29,
  "birthday": "1995-06-15",
  "locale": "en-US"en_US",
  "address": "456 OakNew Avenue,Street, AptSuite 5B"2A",
  "hometown": null,
  "city": "Chicago"New York",
  "state": "Illinois"NY",
  "postal_code": "60601"10002",
  "country": "United States",
  "location": null,
  "telephone": "+1-555-999-8888"111-2222",
  "company": "NewAdvanced CompanyTech Name Inc"Corp",
  "title": "CreativeLead Director"Software Engineer",
  "passport_number": null,
  "country_id": null,
  "tax_id": null,
  "event": null,
  "accept_terms": true,
  "custom_field_1": "UpdatedDepartment: Status"Senior Engineering",
  "custom_field_2": "VIPEmployee Status"ID: SEN001",
  "custom_field_3": null,"Team: Full Stack Development",
  "custom_field_4": null,
  "custom_field_5": null,
  "custom_field_6": null,
  "custom_field_7": null,
  "custom_field_8": null
}

    Response Codes:

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

    DELETE /user_extra/{id}/

    Description: Permanently removes a user extra information record from the system. This endpointoperation cannot be undone and should be used carefullywith ascaution, ittypically permanentlyin deletesdata allcleanup extendedscenarios or user informationaccount associateddeletion with the specified ID.workflows.

    Use Cases:

    • Remove user data uponUser account deletion for GDPR complianceprocesses
    • CleanData upcleanup testand orprivacy invalidcompliance user extra records(GDPR/CCPA)
    • HandleDuplicate userrecord requestsremoval
    forAdministrative data removalmanagement

    Full URL Example:

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

    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/42/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

    Response Codes:

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

    Common Use Cases

    Use Case 1: Complete User Onboarding Workflow

    Implement a multi-step registration process where basic user accounts are created first, then enhanced with detailed profile information using POST /user_extra/. Use PATCH for progressive profile completion as users provide additional information over time.

    Use Case 2: Organization User Management Dashboard

    Build administrative interfaces using GET /user_extra/ with organization filtering to display user profile completion status, demographic analytics, and data quality metrics across the organization.

    Use Case 3: Event Registration System

    UseCollect comprehensive attendee information during event registration using POST /user_extra/ towith collectcustom attendeefields informationfor includingevent-specific contactdata details,like companydietary information,restrictions, accommodation preferences, and dietaryspecial preferencesrequirements.

    in

    Use customCase fields.4: FilterCRM byIntegration organizationand Data Synchronization

    Synchronize customer data between external CRM systems using GET with parent__organization_id to generate attendee lists per company.

    User Analytics Dashboard

    Retrieve demographic data with GET /user_extra/ including age ranges and locations to create user segmentation reports. Use the pagination parameters to handle large datasets efficiently.

    Profile Management Interface

    Implement a user profile editor using GET /user_extra/{id}/ to load current data, then PATCHPUT /user_extra/{id}/ for incrementalcomplete record updates asand usersPATCH modifyfor theirincremental information.changes triggered by external system events.

    Use Case 5: Compliance and Data CollectionPrivacy Management

    StoreImplement KYC information using passport numbers, tax IDs, and country identification. Use custom fields for industry-specificGDPR/CCPA compliance requirements,workflows and delete records withusing DELETE /user_extra/{id}/ whenfor requireddata removal requests and GET operations for data privacy regulations.

    Multi-tenant User Management

    Filter users by organization using parent__organization_id parameter to manage user data across different tenants while maintaining data isolationexport and properaudit accesstrail controls.requirements.

    Best Practices

    • DataPagination Privacy:Strategy: Always implementuse proper access controls and consider GDPR/privacy regulations when collecting and storing user data

    Pagination: Useappropriate limit and offset parametersvalues forwhen retrieving large datasetsdatasets. toStart improvewith smaller page sizes (25-50 records) and adjust based on performance andrequirements. reduce response times

    PartialIncremental Updates: Prefer PATCH over PUT for single field updates to minimize databandwidth transferusage and reduce the risk of overwritingdata unchangedconflicts datain concurrent environments.

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

    Custom Fields:Fields Management: PlanEstablish yourclear naming conventions for custom fieldfields usage in advance and document their purposes forwithin your organization to maintainensure consistency and maintainability across different integrations.

    Error Handling: Implement properrobust error handling for 404 responses when useraccessing records don'tthat exist,may especiallyhave inbeen user-facingdeleted applicationsby other processes, and 403 responses for authorization issues.

    DeviceGeographic Information:Data: OnlyUse requestconsistent country naming conventions and consider implementing country code validation to ensure data quality for location-based features.

    Performance Optimization: Use the device_info parameter only when necessarynecessary, as it may impact response times andfor datalarge usagedatasets.

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

    Back to top