List all requirement types

List all requirement types ordered by created_at descending

GET /requirement_types

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

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

console.log(requirementTypes.data);

200

{
  "data": [
    {
      "acceptance_criteria": {
        "time_limit": "Current and not expired",
        "locality_limit": "Issued by the same country that the phone number belongs to",
        "acceptable_values": [
          "US"
        ],
        "max_length": 20,
        "min_length": 16,
        "acceptable_characters": "abcdef0123456789"
      },
      "description": "Proves the customer has a physical address in the same locality as the phone number",
      "example": "Utility bill, internet bill, phone bill, or lease",
      "type": "document",
      "name": "Proof of Address",
      "record_type": "requirement_type",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "created_at": "2021-04-09T22:25:27.521Z",
      "updated_at": "2021-04-12T20:20:20.020Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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 for requirement types (deepObject style). Originally: filter[name]

Show child attributes

sort · enum<string>[]

Consolidated sort parameter for requirement types (deepObject style). Originally: sort[] Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a - in front of the field name.

Available options: name, created_at, updated_at, -name, -created_at, -updated_at

Example:

["name"]

Response

200

application/json

Successful response

data · object[]

Show child attributes

meta · object

Show child attributes