Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
Useful for sharing or LLM
Accelerate development with AI
On this page
Looking for more inspiration?Visit the

Schema Version resource

Version Properties

version-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
idstring

Optional

Not PII

The unique identifier of the schema. Each schema can have multiple versions, that share the same id.

schemaVersioninteger

Optional

Not PII

The version of this schema.

Default: 0
dateCreatedstring<date-time>

Optional

Not PII

The date the schema version was created, given in ISO 8601 format.

urlstring<uri>

Optional

Not PII

The URL of this resource.

rawstring<uri>

Optional

Not PII

Fetch a SchemaVersion resource

fetch-a-schemaversion-resource page anchor

GET https://events.twilio.com/v1/Schemas/{Id}/Versions/{SchemaVersion}

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
idstring
required
Not PII

The unique identifier of the schema. Each schema can have multiple versions, that share the same id.

schemaVersioninteger
required
Not PII

The version of the schema

Fetch Schema VersionLink to code sample: Fetch Schema Version
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function fetchSchemaVersion() {

14
  const version = await client.events.v1

15
    .schemas("Messaging.MessageStatus")

16
    .versions(42)

17
    .fetch();

18


19
  console.log(version.id);

20
}

21


22
fetchSchemaVersion();

Response

Note about this response
1
{

2
  "id": "Messaging.MessageStatus",

3
  "schema_version": 42,

4
  "date_created": "2015-07-30T20:00:00Z",

5
  "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1",

6
  "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/1"

7
}

Read multiple SchemaVersion resources

read-multiple-schemaversion-resources page anchor

GET https://events.twilio.com/v1/Schemas/{Id}/Versions

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
idstring
required
Not PII

The unique identifier of the schema. Each schema can have multiple versions, that share the same id.

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
pageSizeinteger<int64>

Optional

Not PII

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

Minimum: 1Maximum: 1000
pageinteger

Optional

Not PII

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

Minimum: 0
pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Read Schema VersionLink to code sample: Read Schema Version
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function listSchemaVersion() {

14
  const versions = await client.events.v1

15
    .schemas("Id")

16
    .versions.list({ limit: 20 });

17


18
  versions.forEach((v) => console.log(v.id));

19
}

20


21
listSchemaVersion();

Response

Note about this response
1
{

2
  "schema_versions": [

3
    {

4
      "id": "Messaging.MessageStatus",

5
      "schema_version": 1,

6
      "date_created": "2015-07-30T20:00:00Z",

7
      "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1",

8
      "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/1"

9
    },

10
    {

11
      "id": "Messaging.MessageStatus",

12
      "schema_version": 2,

13
      "date_created": "2015-07-30T20:00:00Z",

14
      "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/2",

15
      "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/2"

16
    }

17
  ],

18
  "meta": {

19
    "page": 0,

20
    "page_size": 50,

21
    "first_page_url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0",

22
    "previous_page_url": null,

23
    "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0",

24
    "next_page_url": null,

25
    "key": "schema_versions"

26
  }

27
}