> ## 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 component definitions

> Returns one page of the custom component definitions.

Lists the component definitions with each one's `cmp_` id, name, where it is used, its relation and its forms. Records are under `data` and paging details under `pagination`. Fields filter as `filter_<field>`.

> [!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 /component
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:
  /component:
    get:
      tags:
        - Custom components
      summary: List component definitions
      description: >-
        Lists the component definitions with each one's `cmp_` id, name, where
        it is used, its relation and its forms. Records are under `data` and
        paging details under `pagination`. Fields filter as `filter_<field>`.
      operationId: custom_components_get_component
      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 read the page after it.
          schema:
            type: string
        - name: sort
          in: query
          required: false
          description: >-
            A field to sort by, such as `created_on`, or `-created_on` for
            newest first.
          schema:
            type: string
            example: '-created_on'
      responses:
        '200':
          description: One page of component definitions, under `data`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentList'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X GET "$EXSITED_BASE_URL/api/v4/component?limit=20" \
              -H "Authorization: Bearer $ACCESS_TOKEN"
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.custom_components.get_component({"limit": 20})
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await client.customComponents.getComponent({limit:
            20});

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


            $client = ClientRegistry::buildClient();


            $response = $client->customComponents->getComponent(['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.custom_components.custom_components_dto.CustomComponentsDto.ComponentList;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ComponentList> response =
            client.customComponents().getComponent(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.CustomComponents.GetComponentAsync(new
            Dictionary<string, object?> { ["limit"] = 20 });


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

            final client = buildClient();

            final response = await client.customComponents.getComponent(
              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.CustomComponents().GetComponent(context.Background(), map[string]any{\"limit\": 20}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ComponentList:
      type: object
      properties:
        object:
          type: string
        url:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Component'
        pagination:
          $ref: '#/components/schemas/ComponentPagination'
    Component:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
          description: The component definition's `cmp_` id.
        status:
          type: string
        name:
          type: string
        display_name:
          type: string
        description:
          type:
            - string
            - 'null'
        use_in:
          type:
            - string
            - 'null'
        relation:
          type:
            - string
            - 'null'
        custom_component: {}
        custom_objects:
          type: array
          items:
            type: object
        custom_forms:
          type: array
          items:
            $ref: '#/components/schemas/ComponentCustomForm'
        child_custom_components:
          type: array
          items:
            type: object
        activity_logs:
          type: array
          items:
            type: object
          description: Present on the create response only.
        created_on:
          type: string
        last_updated_on:
          type: string
        created_by: {}
        last_updated_by: {}
        version:
          type: integer
        href:
          type: string
    ComponentPagination:
      type: object
      properties:
        limit:
          type: integer
          description: The page size applied to this page.
        has_more:
          type: boolean
          description: >-
            Whether another page follows. Trust this over `next_cursor`, which
            can be stale on the last page.
        next_cursor:
          type:
            - string
            - 'null'
        prev_cursor:
          type:
            - string
            - 'null'
        links:
          $ref: '#/components/schemas/ComponentPaginationLinks'
    ComponentCustomForm:
      type: object
      properties:
        column_count:
          type: integer
        data:
          $ref: '#/components/schemas/ComponentCustomFormData'
        id:
          type: string
        object:
          type: string
        template_name:
          type: string
    ComponentPaginationLinks:
      type: object
      properties:
        next:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
    ComponentCustomFormData:
      type: object
      properties:
        firstColumnAttribute:
          type: array
          items:
            $ref: '#/components/schemas/ComponentCustomFormFirstColumnAttribute'
        secondColumnAttribute:
          type: array
          items:
            $ref: '#/components/schemas/ComponentCustomFormSecondColumnAttribute'
        thirdColumnAttribute:
          type: array
          items:
            type: object
    ComponentCustomFormFirstColumnAttribute:
      type: object
      properties:
        canEncrypt:
          type: boolean
        description:
          type: string
        displayName:
          type: string
        enabled:
          type: boolean
        encryptData:
          type: boolean
        entity: {}
        fieldRequired:
          type: boolean
        formMaxLengthInputed:
          type: boolean
        formMinLengthInputed:
          type: boolean
        id:
          type: integer
        ids:
          type: integer
        isRequired:
          type: boolean
        isUnique:
          type: boolean
        maxLength: {}
        metaData:
          type: string
        minLength: {}
        name:
          type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/ComponentCustomFormAttributeOption'
        position:
          type: string
        showInListView:
          type: boolean
        timeFormat: {}
        type:
          type: string
        typeValue:
          type: string
        validationMessage:
          type: string
        validationMessageRequired:
          type: boolean
        value:
          type: string
    ComponentCustomFormSecondColumnAttribute:
      type: object
      properties:
        displayName:
          type: string
        fieldEnabled:
          type: boolean
        fieldRequired:
          type: boolean
        ids:
          type: integer
        name:
          type: string
        showInListView:
          type: boolean
        type:
          type: string
        typeActual:
          $ref: '#/components/schemas/ComponentCustomFormAttributeTypeActual'
        validationMessageRequired:
          type: boolean
    ComponentCustomFormAttributeOption:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    ComponentCustomFormAttributeTypeActual:
      type: object
      properties:
        key:
          type: string
        value:
          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.