Skip to main content

List requirement groups

GET 
/requirement_groups

List requirement groups

Request

Query Parameters

    filter[country_code] string

    Filter requirement groups by country code (iso alpha 2)

    Examples:
    filter[phone_number_type] string

    Possible values: [local, toll_free, mobile, national, shared_cost]

    Filter requirement groups by phone number type.

    filter[action] string

    Possible values: [ordering, porting, action]

    Filter requirement groups by action type

    filter[status] string

    Possible values: [approved, unapproved, pending-approval, declined]

    Filter requirement groups by status

    filter[customer_reference] string

    Filter requirement groups by customer reference

    Examples:

Responses

200: List requirement groups

Request samples


curl -L 'https://api.telnyx.com/v2/requirement_groups' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


[
{
"id": "string",
"country_code": "string",
"phone_number_type": "string",
"status": "approved",
"action": "string",
"customer_reference": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"record_type": "requirement_group",
"regulatory_requirements": [
{
"requirement_id": "string",
"field_value": "string",
"field_type": "string",
"status": "approved",
"expires_at": "2024-07-29T15:51:28.071Z",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
]
}
]