Retrieve a list of all Bundles for an account
TODO: Resource-level docs
Retrieve a list of all Bundles for an account.
Query parameters
-
Status string
The verification status of the Bundle resource. Please refer to Bundle Statuses for more details.
Values are
draft
,pending-review
,in-review
,twilio-rejected
,twilio-approved
, orprovisionally-approved
. -
FriendlyName string
The string that you assigned to describe the resource. The column can contain 255 variable characters.
-
RegulationSid string
The unique string of a Regulation resource that is associated to the Bundle resource.
-
IsoCountry string
The 2-digit ISO country code of the Bundle's phone number country ownership request.
-
NumberType string
The type of phone number of the Bundle's ownership request. Can be
local
,mobile
,national
, ortollfree
. -
HasValidUntilDate boolean
Indicates that the Bundle is a valid Bundle until a specified expiration date.
-
SortBy string
Can be
valid-until
ordate-updated
. Defaults todate-created
.Values are
valid-until
ordate-updated
. -
SortDirection string
Default is
DESC
. Can beASC
orDESC
.Values are
ASC
orDESC
. -
ValidUntilDate string(date-time)
Date to filter Bundles having their
valid_until_date
before or after the specified date. Can beValidUntilDate>=
orValidUntilDate<=
. Both can be used in conjunction as well. ISO 8601 is the acceptable date format. -
ValidUntilDate< string(date-time)
Date to filter Bundles having their
valid_until_date
before or after the specified date. Can beValidUntilDate>=
orValidUntilDate<=
. Both can be used in conjunction as well. ISO 8601 is the acceptable date format. -
ValidUntilDate> string(date-time)
Date to filter Bundles having their
valid_until_date
before or after the specified date. Can beValidUntilDate>=
orValidUntilDate<=
. Both can be used in conjunction as well. ISO 8601 is the acceptable date format. -
PageSize integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum value is
1
, maximum value is1000
.
curl \
-X GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles \
--user "username:password"
{
"meta": {
"first_page_url": "https://example.com",
"key": "string",
"next_page_url": "https://example.com",
"page": 42,
"page_size": 42,
"previous_page_url": "https://example.com",
"url": "https://example.com"
},
"results": [
{
"account_sid": "string",
"date_created": "2023-05-04T09:42:00+00:00",
"date_updated": "2023-05-04T09:42:00+00:00",
"email": "string",
"friendly_name": "string",
"links": {},
"regulation_sid": "string",
"sid": "string",
"status": "draft",
"status_callback": "https://example.com",
"url": "https://example.com",
"valid_until": "2023-05-04T09:42:00+00:00"
}
]
}
{
"meta": {
"first_page_url": "https://example.com",
"key": "string",
"next_page_url": "https://example.com",
"page": 42,
"page_size": 42,
"previous_page_url": "https://example.com",
"url": "https://example.com"
},
"results": [
{
"account_sid": "string",
"date_created": "2024-05-04T09:42:00+00:00",
"date_updated": "2024-05-04T09:42:00+00:00",
"email": "string",
"friendly_name": "string",
"links": {},
"regulation_sid": "string",
"sid": "string",
"status": "draft",
"status_callback": "https://example.com",
"url": "https://example.com",
"valid_until": "2024-05-04T09:42:00+00:00"
}
]
}