Skip to main content
GET
/
requirement_groups
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

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

console.log(requirementGroups);
[
  {
    "id": "<string>",
    "country_code": "<string>",
    "phone_number_type": "<string>",
    "status": "approved",
    "action": "<string>",
    "customer_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "record_type": "requirement_group",
    "regulatory_requirements": [
      {
        "requirement_id": "<string>",
        "field_value": "<string>",
        "field_type": "<string>",
        "status": "approved",
        "expires_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
filter
object

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

Response

200 - application/json

List requirement groups

​
id
string
​
country_code
string
​
phone_number_type
string
​
status
enum<string>
Available options:
approved,
unapproved,
pending-approval,
declined,
expired
​
action
string
​
customer_reference
string
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
record_type
string
Example:

"requirement_group"

​
regulatory_requirements
object[]