Requirement Groups

List requirement groups

Changed on

Returns regulatory requirement groups for the account. Results can be filtered by country, number type, action, approval status, and customer reference.

get/requirement_groups

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/requirement_groups
  • Auth: HTTP bearer

Query parameters

country_codestring

Filter requirement groups by country code (iso alpha 2)

phone_number_type'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost'

Filter requirement groups by phone number type.

action'ordering' | 'porting' | 'action'

Filter requirement groups by action type

status'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired'

Filter requirement groups by status

customer_referencestring

Filter requirement groups by customer reference

Consolidated filter parameter (deepObject style). Originally: filter[country_code], filter[phone_number_type], filter[action], filter[status], filter[customer_reference]

Response

List requirement groups

idstring
country_codestring
phone_number_typestring
status'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired'
actionstring
customer_referencestring
created_atstring date-time
updated_atstring date-time
record_typestring

Example response

[
  {
    "record_type": "requirement_group"
  }
]

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status