Accessible Venues

Retrieves the list of venues available to the authenticated integrator.

What it does:

• Sends a GET request to {{base_url}}/venues
• Optional venueId query parameter to return only the requested Venue.
• Returns venue records (e.g., id, name, status, and other metadata) that your account can access

Notes:

• No request body is required.
• You can add query parameters in the Params tab to filter or paginate if the API supports it.
• If you receive 401/403 responses, verify your auth configuration and that the variables resolve correctly in the active environment.

Model:

• updatedAt: Datetime that the record was last updated.
• name: Name of the Venue
• shortCode: The Venue Short Code identifier
• id: ID of the Venue
• parentId: ID of the Enterprise that the Venue belongs to
• isActive: Boolean indicating if the Venue is Active
• businessDate: The current businessDate of the Venue
• firstBusinessDate: If set, the first business date for which NX housed legitimate transactions for the Venue.
• payrollPeriodStartDateTime: The current start date of a payroll period. In NX Date format
• payrollPeriodEndDateTime: The current end date of a payroll period. In NX Date format
• payrollPeriodId: The current payrollPeriod record Id.