v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Requirement Groups

List requirement groups

get/requirement_groups

Query parameters

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

Filter requirement groups by action type

country_codestring

Filter requirement groups by country code (iso alpha 2)

customer_referencestring

Filter requirement groups by customer reference

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

Filter requirement groups by phone number type.

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

Filter requirement groups by status

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

Response

List requirement groups

actionstring

country_codestring

created_atstring date-time

customer_referencestring

idstring

phone_number_typestring

record_typestring

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

updated_atstring date-time

Example response

[
  {
    "record_type": "requirement_group"
  }
]