> ## Documentation Index
> Fetch the complete documentation index at: https://developers.illuxi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get group by external ID

> Returns a [grp](/concepts/grp) by its external ID



## OpenAPI

````yaml GET /grp/get_by_external_id/{external_id}
openapi: 3.0.0
info:
  version: 2.0.0
  title: illuxiLMS API
  description: Interact with the illuxiLMS API to manage your learning content and users.
  termsOfService: https://illuxi.com/conditions-utilisation/
  contact:
    name: illuxi Team
    email: info@illuxi.com
    url: https://illuxi.com
servers:
  - url: https://{portalApiUrl}
    description: Production server (uses live data)
    variables:
      portalApiUrl:
        default: your-portal.acme.com/api-v2
        description: Your portal's API URL
security:
  - bearerAuth: []
paths:
  /grp/get_by_external_id/{external_id}:
    get:
      description: Returns a [grp](/concepts/grp) by its external ID
      operationId: getGrpByExternalId
      parameters:
        - name: external_id
          in: path
          description: External ID of the group
          required: true
          schema:
            type: string
      responses:
        '200':
          description: group response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                  result:
                    $ref: '#/components/schemas/Grp'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Grp:
      type: object
      properties:
        grp_id:
          type: integer
          description: Unique identifier of the group
          readOnly: true
        grp_name:
          type: string
          description: Internal key name of the group
        grp_description:
          type: string
          nullable: true
          description: Human-readable description of the group
        grp_parent_id:
          type: integer
          nullable: true
          description: ID of the parent group (for nested groups)
        grp_external_id:
          type: string
          nullable: true
          description: External identifier for integration with third-party systems
        grp_external_name:
          type: string
          nullable: true
          description: Alternate name from the external system
        grp_created_date:
          type: string
          format: date-time
          readOnly: true
          description: Date the group was created
        grp_updated_date:
          type: string
          format: date-time
          readOnly: true
          description: Date the group was last updated
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Authentication token obtained from POST /token

````