> ## Documentation Index > Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List orders > Lists orders, one page at a time. The records are under `data`, and `pagination` holds the cursor for the next page. Each record holds the order's header fields; read one order for its lines and totals. To filter, add `filter_=`. > [!NOTE] > > The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). ## OpenAPI ````yaml GET /orders openapi: 3.1.0 info: title: Exsited API version: v4 servers: - url: https://{host}/api/v4 variables: host: default: your-api-host.example.com description: Your Exsited API host name, without https://. security: - bearerAuth: [] tags: - name: Authentication - name: Accounts - name: Account emails - name: Account groups - name: Communications - name: Communication profiles - name: Orders - name: Quote orders - name: Express - name: Usages - name: Sales reps - name: Gift certificates - name: Invoices - name: Pro-forma invoices - name: Payments - name: Refunds - name: Credit notes - name: Credit note applications - name: Reconciliations - name: Items - name: Inventory adjustments - name: Units of measurement - name: Zones - name: Shipping packages - name: Shipping rules - name: Fulfillment profiles - name: Fulfillment terms - name: Item fulfillments - name: Item receipts - name: Bookings - name: Rental assets - name: Return merchandise authorisations - name: Purchase orders - name: Purchase invoices - name: Purchase payments - name: Purchase refunds - name: Purchase credit notes - name: Purchase credit note applications - name: Purchase express - name: Return vendor authorizations - name: ABA files - name: Receive terms - name: Labours - name: Tasks - name: Timesheets - name: Milestones - name: Employees - name: Departments - name: Designations - name: Teams - name: Time periods - name: Workflows - name: Workflow settings - name: Events - name: Custom events - name: System events - name: Approvals - name: Approval profiles - name: Approval user groups - name: Alerts - name: Alert responsibility settings - name: Alert responsibilities - name: Action scripts - name: Note groups - name: Note attachments - name: Instance settings - name: Accounting codes - name: Additional codes - name: Billing periods - name: Charging periods - name: Pricing periods - name: Invoice terms - name: Days of the month - name: Countries - name: Salutations - name: Document templates - name: Email templates - name: Roles - name: Operators - name: Operator groups - name: User settings - name: Custom attributes - name: Custom components - name: Custom features - name: Custom fields - name: Custom forms - name: Attribute attachments - name: Portal - name: Integration connections - name: External databases - name: Reports - name: Applications - name: Organisation - name: Child organisations - name: Webhooks paths: /orders: get: tags: - Orders summary: List orders description: >- The records are under `data`, and `pagination` holds the cursor for the next page. Each record holds the order's header fields; read one order for its lines and totals. To filter, add `filter_=`. operationId: orders_get_orders parameters: - name: limit in: query required: false description: The most records to return on one page. schema: type: integer example: 20 - name: cursor in: query required: false description: >- The `next_cursor` from the previous page, to fetch the page after it. schema: type: string - name: sort in: query required: false description: >- The field to sort by. Prefix it with `-` to sort in descending order. schema: type: string example: '-created_on' responses: '200': description: One page of orders, under `data`. content: application/json: schema: $ref: '#/components/schemas/OrderList' x-codeSamples: - lang: bash label: cURL source: |- curl -X GET "$EXSITED_BASE_URL/api/v4/orders?limit=20" \ -H "Authorization: Bearer $ACCESS_TOKEN" - lang: python label: Python source: | from exsited import build_client client = build_client() response = client.orders.get_orders({"limit": 20}) print(response.data) - lang: javascript label: JavaScript source: | import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.orders.getOrders({limit: 20}); console.log(response.data); - lang: php label: PHP source: | use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->orders->getOrders(['limit' => 20]); print_r($response->data); - lang: java label: Java source: > import com.exsited.client.ApiResponse; import com.exsited.client.ClientRegistry; import com.exsited.client.ExsitedClient; import com.exsited.resources.orders.orders_dto.OrdersDto.OrderList; import java.util.Map; ExsitedClient client = ClientRegistry.buildClient(); ApiResponse response = client.orders().getOrders(Map.of("limit", 20)); System.out.println(response.getMap()); - lang: csharp label: .NET source: > using Exsited.Client; await using var client = ExsitedClient.BuildClient(); var response = await client.Orders.GetOrdersAsync(new Dictionary { ["limit"] = 20 }); Console.WriteLine(response.Json); - lang: dart label: Dart source: > import 'package:exsited/exsited.dart'; final client = buildClient(); final response = await client.orders.getOrders(queryParams: {'limit': 20}); print(response.map); - lang: go label: Go source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Orders().GetOrders(context.Background(), map[string]any{\"limit\": 20}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: schemas: OrderList: type: object properties: data: type: array items: $ref: '#/components/schemas/Order' object: type: string pagination: $ref: '#/components/schemas/OrderPagination' url: type: string Order: type: object properties: account: $ref: '#/components/schemas/OrderAccount' allow_contract: type: boolean billing_address: $ref: '#/components/schemas/OrderBillingAddress' billing_preferences: $ref: '#/components/schemas/OrderBillingPreferencesEntry' billing_start_date: type: string billing_start_day_of_month: type: string communication_preferences: type: array items: $ref: '#/components/schemas/OrderCommunicationPreference' contract_properties: $ref: '#/components/schemas/OrderContractProperties' created_by: {} created_on: type: string currency: $ref: '#/components/schemas/OrderCurrency' custom_form: $ref: '#/components/schemas/OrderCustomForm' customer_purchase_order_id: type: string description: type: string discount_profile: $ref: '#/components/schemas/OrderDiscountProfile' display_name: type: string id: type: string invoice_note: type: string last_updated_by: {} last_updated_on: type: string manager: $ref: '#/components/schemas/OrderManager' name: type: string next_billing_from_date: type: string next_billing_from_date_utc: type: string object: type: string order_start_date: type: string order_type: type: string origin: type: string original_total: type: string pre_order: type: boolean price_tax_inclusive: type: boolean quote_converted: type: boolean quote_order: type: boolean referral_account: $ref: '#/components/schemas/OrderReferralAccount' sales_rep: $ref: '#/components/schemas/OrderSalesRep' shipping_address: $ref: '#/components/schemas/OrderShippingAddress' shipping_cost: type: number shipping_profile: $ref: '#/components/schemas/OrderShippingProfile' status: type: string time_zone: $ref: '#/components/schemas/OrderTimeZone' version: type: integer OrderPagination: type: object description: Cursor paging for the listing. properties: limit: type: integer description: The page size the API applied. has_more: type: boolean description: >- Whether another page follows. `false` ends the listing even when `next_cursor` is present. next_cursor: type: string description: Send as `cursor` to fetch the next page. prev_cursor: type: string links: type: object properties: next: type: string prev: type: string OrderAccount: type: object properties: object: type: string id: type: string name: type: string href: type: string OrderBillingAddress: type: object properties: address_line_1: type: string address_line_2: type: string address_line_3: type: string address_line_4: type: string address_line_5: type: string city: type: string country: type: string name: type: string postal_code: type: string state: type: string OrderBillingPreferencesEntry: type: object properties: billing_period: type: string communication_profile: type: string consolidate_invoice: type: boolean consolidate_key: type: string fulfillment_mode: type: string fulfillment_term: type: string invoice_mode: type: string invoice_term: type: string payment_mode: type: string payment_processor: type: string payment_term: type: string payment_term_alignment: type: string proforma_properties: $ref: '#/components/schemas/OrderBillingPreferencesEntryProformaProperties' OrderCommunicationPreference: type: object properties: channel: type: string enabled: type: boolean OrderContractProperties: type: object properties: allow_downgrade: type: boolean allow_downgrade_charge: type: boolean allow_early_termination: type: boolean allow_postponement: type: boolean allow_trial: type: boolean allow_upgrade: type: boolean auto_renewal_ends_on: type: string auto_renewal_require_customer_acceptance: type: boolean auto_renewal_term: type: string downgrade_charge_fixed: type: string downgrade_charge_type: type: string initial_contract_term: type: string period_before_downgrade: type: string renew_automatically: type: string require_customer_acceptance: type: boolean requires_payment_method: type: boolean termination_accounting_code: type: string termination_notice_period: type: string OrderCurrency: type: object properties: code: type: string href: type: string id: type: string name: type: string object: type: string OrderCustomForm: type: object properties: object: type: string id: type: string name: type: string href: type: string OrderDiscountProfile: type: object properties: amount: type: string href: type: string id: type: string name: type: string object: type: string redemption_code: type: string type: type: string OrderManager: type: object properties: object: type: string id: type: string name: type: string href: type: string OrderReferralAccount: type: object properties: href: type: string id: type: string object: type: string OrderSalesRep: type: object properties: object: type: string id: type: string name: type: string href: type: string OrderShippingAddress: type: object properties: address_line_1: type: string address_line_2: type: string address_line_3: type: string address_line_4: type: string address_line_5: type: string city: type: string country: type: string name: type: string postal_code: type: string state: type: string OrderShippingProfile: type: object properties: object: type: string id: type: string name: type: string href: type: string OrderTimeZone: type: object properties: object: type: string id: type: string name: type: string href: type: string OrderBillingPreferencesEntryProformaProperties: type: object properties: acceptance_date: {} acceptance_required: type: boolean acceptance_term: type: string payment_required: type: boolean terms_and_conditions: {} securitySchemes: bearerAuth: type: http scheme: bearer description: >- An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.