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

# List requirement groups



## OpenAPI

````yaml https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/regulatory.yml get /requirement_groups
openapi: 3.1.0
info:
  title: Telnyx Regulatory Requirements API
  version: 2.0.0
  description: API for Regulatory requirements.
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
security:
  - bearerAuth: []
paths:
  /requirement_groups:
    get:
      tags:
        - Requirement Groups
      summary: List requirement groups
      operationId: GetRequirementGroups
      parameters:
        - name: filter
          in: query
          style: deepObject
          explode: true
          description: >-
            Consolidated filter parameter (deepObject style). Originally:
            filter[country_code], filter[phone_number_type], filter[action],
            filter[status], filter[customer_reference]
          schema:
            type: object
            properties:
              country_code:
                type: string
                description: Filter requirement groups by country code (iso alpha 2)
              phone_number_type:
                type: string
                enum:
                  - local
                  - toll_free
                  - mobile
                  - national
                  - shared_cost
                description: Filter requirement groups by phone number type.
              action:
                type: string
                enum:
                  - ordering
                  - porting
                  - action
                description: Filter requirement groups by action type
              status:
                type: string
                enum:
                  - approved
                  - unapproved
                  - pending-approval
                  - declined
                  - expired
                description: Filter requirement groups by status
              customer_reference:
                type: string
                description: Filter requirement groups by customer reference
      responses:
        '200':
          description: List requirement groups
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RequirementGroup'
        '400':
          $ref: '#/components/responses/numbers_BadRequestResponse'
        '401':
          $ref: '#/components/responses/numbers_UnauthorizedResponse'
        '422':
          $ref: '#/components/responses/numbers_UnprocessableEntity'
        '500':
          $ref: '#/components/responses/numbers_GenericErrorResponse'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Telnyx from 'telnyx';

            const client = new Telnyx({
              apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
            });

            const requirementGroups = await client.requirementGroups.list();

            console.log(requirementGroups);
        - lang: Python
          source: |-
            import os
            from telnyx import Telnyx

            client = Telnyx(
                api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
            )
            requirement_groups = client.requirement_groups.list()
            print(requirement_groups)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trequirementGroups, err := client.RequirementGroups.List(context.TODO(), telnyx.RequirementGroupListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", requirementGroups)\n}\n"
        - lang: Java
          source: >-
            package com.telnyx.sdk.example;


            import com.telnyx.sdk.client.TelnyxClient;

            import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

            import com.telnyx.sdk.models.requirementgroups.RequirementGroup;

            import
            com.telnyx.sdk.models.requirementgroups.RequirementGroupListParams;


            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    TelnyxClient client = TelnyxOkHttpClient.fromEnv();

                    List<RequirementGroup> requirementGroups = client.requirementGroups().list();
                }
            }
        - lang: Ruby
          source: |-
            require "telnyx"

            telnyx = Telnyx::Client.new(api_key: "My API Key")

            requirement_groups = telnyx.requirement_groups.list

            puts(requirement_groups)
        - lang: CLI
          source: |-
            telnyx requirement-groups list \
              --api-key 'My API Key'
components:
  schemas:
    RequirementGroup:
      type: object
      properties:
        id:
          type: string
        country_code:
          type: string
        phone_number_type:
          type: string
        status:
          type: string
          enum:
            - approved
            - unapproved
            - pending-approval
            - declined
            - expired
        action:
          type: string
        customer_reference:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        record_type:
          type: string
          example: requirement_group
        regulatory_requirements:
          type: array
          items:
            $ref: '#/components/schemas/UserRequirement'
    UserRequirement:
      type: object
      properties:
        requirement_id:
          type: string
        field_value:
          type: string
        field_type:
          type: string
        status:
          type: string
          enum:
            - approved
            - unapproved
            - pending-approval
            - declined
            - expired
        expires_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    numbers_Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/numbers_Error'
      type: object
    numbers_Error:
      properties:
        code:
          type: string
          example: '10007'
        title:
          type: string
          example: Unexpected error
        detail:
          type: string
          example: An unexpected error occured.
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              example: /base
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties:
            url:
              type: string
              description: URL with additional information on the error.
              example: https://developers.telnyx.com/docs/overview/errors/10015
      type: object
  responses:
    numbers_BadRequestResponse:
      description: >-
        Bad request, the request was unacceptable, often due to missing a
        required parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
    numbers_UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
          examples:
            Authentication Failed:
              value:
                errors:
                  - code: '10009'
                    title: Authentication failed
                    detail: Could not understand the provided credentials.
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10009
    numbers_UnprocessableEntity:
      description: Unprocessable entity. Check the 'detail' field in response for details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
    numbers_GenericErrorResponse:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````