Jump to Content
Lockstep Platform APIDeveloperStatusBlog
GuidesRecipesAPI ReferenceDiscussions
v1.0

DeveloperStatusBlogLog InLockstep Platform API
Log In
v1.0GuidesRecipesAPI ReferenceDiscussions

Getting Started

  • The easiest way to connect to accounting data
  • Lockstep SDKs
  • Querying with Searchlight
  • Extensibility
  • Identity Columns
  • Applications and Enrollments
  • Companies, Customers, and Vendors
  • Accounts and GroupKeys

Tutorials

  • Fetch Invoices
  • Build a Connector
  • Postman Collection

Authentication

  • JWT Bearer Tokens
  • API Keys
  • Testing Authentication

Integrations

  • Onboarding
  • Connector Data
    • BatchSyncModel
    • CompanySyncModel
    • ContactSyncModel
    • CreditMemoAppliedSyncModel
    • CustomFieldSyncModel
    • FinancialAccountBalanceHistorySyncModel
    • FinancialAccountSyncModel
    • FinancialYearSettingSyncModel
    • InvoiceLineSyncModel
    • InvoiceSyncModel
    • PaymentAppliedSyncModel
    • PaymentSyncModel

Data Definitions

  • Accounting
    • CustomerDetailsModel
    • CustomerDetailsPaymentModel
    • CompanyDetailsModel
    • CompanyDetailsPaymentModel
    • CompanyModel
    • ContactModel
    • CreditMemoAppliedModel
    • CreditMemoInvoiceModel
    • CustomerSummaryModel
    • InvoiceAddressModel
    • InvoiceHistoryModel
    • InvoiceLineModel
    • InvoiceModel
    • InvoicePaymentDetailModel
    • InvoiceSummaryModel
    • PaymentAppliedModel
    • PaymentDetailHeaderModel
    • PaymentDetailModel
    • PaymentModel
    • PaymentSummaryModel
    • VendorSummaryModel
  • Applications
    • AvailableGroup
    • AvailableMigrationsModel
    • MigrationResultModel
    • AppEnrollmentReconnectRequest
    • AppEnrollmentCustomFieldModel
    • AppEnrollmentModel
    • ApplicationModel
    • ConnectorInfoModel
    • SyncEntityResultModel
    • SyncRequestModel
    • SyncSubmitModel
  • Extensibility
    • AttachmentModel
    • CodeDefinitionModel
    • CustomFieldDefinitionModel
    • CustomFieldValueModel
    • NoteModel
  • Reference
    • ErpInfoDataModel
    • ErpInfoModel
    • ActionResultModel
    • BulkCurrencyConversionModel
    • CountryModel
    • CurrencyModel
    • CurrencyRateModel
    • ErpModel
    • StateModel
  • Reporting
    • TrialBalanceReportCellModel
    • TrialBalanceReportModel
    • TrialBalanceReportRowModel
    • AgingModel
    • ApAgingHeaderInfoModel
    • ApHeaderInfoModel
    • ArAgingHeaderInfoModel
    • ArHeaderInfoModel
    • AtRiskInvoiceSummaryModel
    • AttachmentHeaderInfoModel
    • CashflowReportModel
    • DailyPayableOutstandingReportModel
    • DailySalesOutstandingReportModel
    • DpoSummaryGroupTotalModel
    • DpoSummaryModel
    • FinancialAccountBalanceHistoryModel
    • FinancialAccountModel
    • FinancialReportCellModel
    • FinancialReportModel
    • FinancialReportRowModel
    • FinancialYearSettingModel
    • InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult
    • InvoiceSummaryTotalsModel
    • PayablesComingDueHeaderModel
    • PayablesComingDueModel
    • PayablesComingDueWidgetModel
    • PayablesSummaryReportModel
    • PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult
    • PaymentSummaryTotalsModel
    • RiskRateModel
    • SummaryAgingTotalsModel
    • TransactionDetailModel
    • TransactionModel
    • TransactionModelTransactionSummaryTotalModelSummaryFetchResult
    • TransactionSummaryTotalModel
  • Utility
    • ApiKeyModel
    • AppEnrollmentReconnectInfo
    • BulkDeleteRequestModel
    • DeleteResult
    • DeveloperAccountSubmitModel
    • ErrorResult
    • FeatureFlagsRequestModel
    • FeatureFlagsResponseModel
    • GroupAccountModel
    • InviteDataModel
    • InviteModel
    • InviteSubmitModel
    • LeadModel
    • MagicLinkModel
    • MagicLinkStatusModel
    • StatusModel
    • TranscriptionValidationRequest
    • TranscriptionValidationRequestItem
    • TranscriptionRequestSubmit
    • TransferOwnerModel
    • TransferOwnerSubmitModel
    • UriModel
    • UserAccountModel
    • UserDataResponseModel
    • UserGroupModel
    • UserRoleModel
    • ViewBoxSettingsModel
    • WebhookHistoryTableStorageModel
    • WebhookModel
    • WebhookRuleModel
  • Lockstep Connections
    • AccountingProfileContactModel
    • AccountingProfileModel
    • PublicCompanyProfileModel
  • BaseCurrencySyncModel
  • SupportAccessModel
  • SupportAccessRequest
  • TranscriptionValidationRequestItemModel
  • TranscriptionValidationRequestModel
Powered by 

UserDataResponseModel

Suggest Edits

Contains data about the current user.

Methods

The following API methods use this data model.

  • Get User Data

Required Fields

userId

uuid

The Lockstep Platform ID of the user

Optional Fields

data

object, nullable

Data about the user, the properties returned will depend on the requested information.

Updated about 2 months ago


  • Table of Contents
    • Methods
    • Required Fields
      • userId
    • Optional Fields
      • data