Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

EndUserType resource



EndUserType Properties

endusertype-properties page anchor
sidSID<OY>
Not PII

The unique string that identifies the End-User Type resource.

Pattern: ^OY[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestring

A human-readable description that is assigned to describe the End-User Type resource. Examples can include first name, last name, email, business name, etc


machine_namestring

A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc.


fieldsarray

The required information for creating an End-User. The required fields will change as regulatory needs change and will differ for businesses and individuals.


urlstring<uri>

The absolute URL of the End-User Type resource.


Fetch a specific End-User Type Instance.

fetch-a-specific-end-user-type-instance page anchor
GET https://trusthub.twilio.com/v1/EndUserTypes/{Sid}

Path parameters

path-parameters page anchor
Sidstringrequired

The unique string that identifies the End-User Type resource.

Fetch an EndUserType

fetch-an-endusertype page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.endUserTypes('OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(end_user_type => console.log(end_user_type.friendlyName));

Output

_38
{
_38
"url": "https://trusthub.twilio.com/v1/EndUserTypes/OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_38
"fields": [
_38
{
_38
"machine_name": "last_name",
_38
"friendly_name": "Last Name",
_38
"constraint": "String"
_38
},
_38
{
_38
"machine_name": "email",
_38
"friendly_name": "Email",
_38
"constraint": "String"
_38
},
_38
{
_38
"machine_name": "first_name",
_38
"friendly_name": "First Name",
_38
"constraint": "String"
_38
},
_38
{
_38
"machine_name": "business_title",
_38
"friendly_name": "Business Title",
_38
"constraint": "String"
_38
},
_38
{
_38
"machine_name": "phone_number",
_38
"friendly_name": "Phone Number",
_38
"constraint": "String"
_38
},
_38
{
_38
"machine_name": "job_position",
_38
"friendly_name": "Job Position",
_38
"constraint": "String"
_38
}
_38
],
_38
"machine_name": "authorized_representative_1",
_38
"friendly_name": "Authorized Representative one",
_38
"sid": "OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_38
}


Retrieve a list of all End-User Types.

retrieve-a-list-of-all-end-user-types page anchor
GET https://trusthub.twilio.com/v1/EndUserTypes

PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

Pageinteger

The page index. This value is simply for client state.

Minimum: 0

PageTokenstring

The page token. This is provided by the API.

List multiple EndUserTypes

list-multiple-endusertypes page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.endUserTypes
_10
.list({limit: 20})
_10
.then(endUserTypes => endUserTypes.forEach(e => console.log(e.sid)));

Output

_51
{
_51
"meta": {
_51
"page": 0,
_51
"page_size": 50,
_51
"first_page_url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0",
_51
"previous_page_url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0",
_51
"url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0",
_51
"next_page_url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=1",
_51
"key": "end_user_types"
_51
},
_51
"end_user_types": [
_51
{
_51
"url": "https://trusthub.twilio.com/v1/EndUserTypes/OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_51
"fields": [
_51
{
_51
"machine_name": "last_name",
_51
"friendly_name": "Last Name",
_51
"constraint": "String"
_51
},
_51
{
_51
"machine_name": "email",
_51
"friendly_name": "Email",
_51
"constraint": "String"
_51
},
_51
{
_51
"machine_name": "first_name",
_51
"friendly_name": "First Name",
_51
"constraint": "String"
_51
},
_51
{
_51
"machine_name": "business_title",
_51
"friendly_name": "Business Title",
_51
"constraint": "String"
_51
},
_51
{
_51
"machine_name": "phone_number",
_51
"friendly_name": "Phone Number",
_51
"constraint": "String"
_51
},
_51
{
_51
"machine_name": "job_position",
_51
"friendly_name": "Job Position",
_51
"constraint": "String"
_51
}
_51
],
_51
"machine_name": "authorized_representative_1",
_51
"friendly_name": "Authorized Representative one",
_51
"sid": "OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_51
}
_51
]
_51
}


Rate this page: