> ## 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.

# Retrieve a labour profile

> Retrieves one labour profile with its sessions and labours.

Returns the profile under `labour_profile`, including its `sessions`, `labours` and `activity_logs`.

> [!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 /labour_profiles/{labour_profile_id}
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:
  /labour_profiles/{labour_profile_id}:
    get:
      tags:
        - Labours
      summary: Retrieve a labour profile
      description: >-
        Returns the profile under `labour_profile`, including its `sessions`,
        `labours` and `activity_logs`.
      operationId: labours_get_labour_profile
      parameters:
        - name: labour_profile_id
          in: path
          required: true
          description: The labour profile's `id`.
          schema:
            type: string
      responses:
        '200':
          description: The labour profile, under `labour_profile`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabourProfileViewResponse'
        '404':
          description: >-
            No labour profile has that `id`, for example because it has been
            deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X GET
            "$EXSITED_BASE_URL/api/v4/labour_profiles/5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN"
        - lang: python
          label: Python
          source: >
            from exsited import build_client


            client = build_client()


            response =
            client.labours.get_labour_profile("5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d")

            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.labours.getLabourProfile('5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d');

            console.log(response.data);
        - lang: php
          label: PHP
          source: >
            use Exsited\Client\ClientRegistry;


            $client = ClientRegistry::buildClient();


            $response =
            $client->labours->getLabourProfile('5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d');

            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.LabourProfileView;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<LabourProfileView> response =
            client.labours().getLabourProfile("5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d");

            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Labours.GetLabourProfileAsync("5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d");


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.labours.getLabourProfile(
              '5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d',
            );
            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().GetLabourProfile(context.Background(), \"5e7a9c1b-3d4f-4a6b-8c0d-2e4f6a8b0c1d\", nil, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    LabourProfileViewResponse:
      type: object
      properties:
        labour_profile:
          $ref: '#/components/schemas/LabourProfileView'
    Error:
      type: object
      description: Every failed call returns this body.
      properties:
        object:
          type: string
          description: Always `error`.
        request_id:
          type: string
          description: Quote this to support.
        status:
          type: integer
          description: The HTTP status.
        code:
          type: string
          description: What went wrong, such as `validation_error`.
        message:
          type: string
          description: A short description of the problem.
        doc_url:
          type: string
          description: A link to more about this error.
        errors:
          type: array
          description: One entry per field that failed.
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              doc_url:
                type: string
    LabourProfileView:
      type: object
      properties:
        activity_logs:
          type: array
        created_by:
          $ref: '#/components/schemas/LabourProfileViewCreatedBy'
        created_on:
          type: string
        currency:
          $ref: '#/components/schemas/LabourProfileViewCurrency'
        display_name:
          type: string
        href:
          type: string
        id:
          type: string
        labours:
          type: array
          items:
            $ref: '#/components/schemas/LabourProfileViewRow'
        last_updated_by:
          $ref: '#/components/schemas/LabourProfileViewLastUpdatedBy'
        last_updated_on:
          type: string
        max_booking_limit:
          type: integer
        name:
          type: string
        object:
          type: string
        sessions:
          type: array
          items:
            $ref: '#/components/schemas/LabourProfileViewSession'
        status:
          type: string
        tax:
          $ref: '#/components/schemas/LabourProfileViewTax'
        tax_inclusive:
          type: boolean
        version:
          type: integer
    LabourProfileViewCreatedBy:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    LabourProfileViewCurrency:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    LabourProfileViewRow:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    LabourProfileViewLastUpdatedBy:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    LabourProfileViewSession:
      type: object
      properties:
        allow_overtime:
          type: boolean
        availability:
          type: array
          items:
            $ref: '#/components/schemas/LabourProfileViewSessionAvailability'
        end_date:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
        prices:
          type: array
          items:
            $ref: '#/components/schemas/LabourProfileViewSessionPrice'
        start_date:
          type: string
        status:
          type: string
        working_hours:
          type: array
          items:
            $ref: '#/components/schemas/LabourProfileViewSessionWorkingHour'
    LabourProfileViewTax:
      type: object
      properties:
        href:
          type: string
        id:
          type: string
        object:
          type: string
    LabourProfileViewSessionAvailability:
      type: object
      properties:
        available:
          type: boolean
        end_time:
          type: string
        id:
          type: string
        object:
          type: string
        preferred_day:
          type: string
        start_time:
          type: string
        status:
          type: string
    LabourProfileViewSessionPrice:
      type: object
      properties:
        enabled_pro_rata:
          type: boolean
        hours:
          type: array
          items:
            $ref: '#/components/schemas/LabourProfileViewSessionPriceHour'
        id:
          type: string
        object:
          type: string
        peak_hourly:
          type: array
        price:
          type: number
        price_type:
          type: string
        pricing_level:
          $ref: '#/components/schemas/LabourProfileViewSessionPricePricingLevel'
        status:
          type: string
    LabourProfileViewSessionWorkingHour:
      type: object
      properties:
        end_time:
          type: string
        id:
          type: string
        object:
          type: string
        start_time:
          type: string
        status:
          type: string
    LabourProfileViewSessionPriceHour:
      type: object
      properties:
        end_time:
          type: string
        id:
          type: string
        object:
          type: string
        price:
          type: number
        start_time:
          type: string
        status:
          type: string
    LabourProfileViewSessionPricePricingLevel:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          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.