> ## 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 labours > Lists labours, one page at a time. Returns one page of labours under `data`, with `pagination` for the next page. Each labour carries its `id`, `code`, `name`, `status`, `labour_profile`, `labour_contacts` and availability. Any other field of the record filters the listing as `filter_` or `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 /labours 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: /labours: get: tags: - Labours summary: List labours description: >- Returns one page of labours under `data`, with `pagination` for the next page. Each labour carries its `id`, `code`, `name`, `status`, `labour_profile`, `labour_contacts` and availability. Any other field of the record filters the listing as `filter_` or `filter__`. operationId: labours_get_labours parameters: - name: limit in: query required: false description: How many records to return on one page. schema: type: integer example: 20 - name: cursor in: query required: false description: The `next_cursor` of 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 `-` for descending order, such as `-created_on`. schema: type: string example: '-created_on' responses: '200': description: One page of labours. content: application/json: schema: $ref: '#/components/schemas/LabourList' x-codeSamples: - lang: bash label: cURL source: |- curl -X GET "$EXSITED_BASE_URL/api/v4/labours?limit=20" \ -H "Authorization: Bearer $ACCESS_TOKEN" - lang: python label: Python source: | from exsited import build_client client = build_client() response = client.labours.get_labours({"limit": 20}) print(response.data) - lang: javascript label: JavaScript source: | import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.labours.getLabours({limit: 20}); console.log(response.data); - lang: php label: PHP source: | use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->labours->getLabours(['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.labours.labours_dto.LaboursDto.LabourList; import java.util.Map; ExsitedClient client = ClientRegistry.buildClient(); ApiResponse response = client.labours().getLabours(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.Labours.GetLaboursAsync(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.labours.getLabours(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.Labours().GetLabours(context.Background(), map[string]any{\"limit\": 20}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: schemas: LabourList: type: object properties: data: type: array items: $ref: '#/components/schemas/Labour' object: type: string pagination: $ref: '#/components/schemas/LabourPagination' url: type: string Labour: type: object properties: activity_logs: type: array code: type: string created_by: $ref: '#/components/schemas/LabourCreatedBy' created_on: type: string custom_form: $ref: '#/components/schemas/LabourCustomForm' description: type: string display_name: type: string email_address: type: string href: type: string id: type: string image_name: type: 'null' labour_availability: type: array labour_contacts: type: array items: $ref: '#/components/schemas/LabourLabourContact' labour_custom_availability: type: array items: $ref: '#/components/schemas/LabourLabourCustomAvailability' labour_profile: $ref: '#/components/schemas/LabourLabourProfile' last_updated_by: $ref: '#/components/schemas/LabourLastUpdatedBy' last_updated_on: type: string name: type: string object: type: string status: type: string use_custom_availability: type: boolean version: type: integer LabourPagination: type: object properties: limit: type: integer description: The page size applied to this page. has_more: type: boolean description: >- Whether another page follows. Rely on this rather than on `next_cursor`, which can still hold a value on the last page. next_cursor: type: string description: Pass as `cursor` to fetch the next page. prev_cursor: type: string links: $ref: '#/components/schemas/LabourPaginationLinks' LabourCreatedBy: type: object properties: object: type: string id: type: string name: type: string href: type: string LabourCustomForm: type: object properties: object: type: string id: type: string name: type: string href: type: string LabourLabourContact: 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 contact_type: type: string country: type: string designation: type: string email_address: type: string fax: $ref: '#/components/schemas/LabourLabourContactFax' first_name: type: string id: type: string last_name: type: string middle_name: type: 'null' mobile: $ref: '#/components/schemas/LabourLabourContactMobile' object: type: string phone: $ref: '#/components/schemas/LabourLabourContactPhone' post_code: type: string receive_email: type: boolean salutation: type: string state: type: string status: type: string LabourLabourCustomAvailability: type: object properties: available: type: boolean end_time: type: string id: type: string object: type: string preferred_day: type: string start_time: type: string LabourLabourProfile: type: object properties: object: type: string id: type: string name: type: string href: type: string LabourLastUpdatedBy: type: object properties: object: type: string id: type: string name: type: string href: type: string LabourPaginationLinks: type: object properties: next: type: string prev: type: string LabourLabourContactFax: type: object properties: area_code: type: string country_code: type: string do_not_call: type: boolean full: type: string number: type: string LabourLabourContactMobile: type: object properties: area_code: type: string country_code: type: string do_not_call: type: boolean full: type: string number: type: string LabourLabourContactPhone: type: object properties: area_code: type: string country_code: type: string do_not_call: type: boolean full: type: string number: type: string 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.