List Sequence Templates
List the sequence templates available in the workspace.
Requires the sequences:read scope on the API key.
curl --request GET \
--url https://api.topo.io/v1/sequence-templates \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topo.io/v1/sequence-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/sequence-templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"summary": "<string>",
"status": "PENDING_SETUP",
"step_count": 123,
"language": "<string>",
"timezone": "<string>",
"activated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total_count": 123,
"total_pages": 123,
"has_more": true
}Authorizations
Bearer API key issued from Settings → Developers.
Query Parameters
Page number.
x >= 1Number of items per page.
1 <= x <= 100Field to sort by.
created_at, updated_at, name Sort direction.
asc, desc Filter by template name (exact match).
Filter by lifecycle state.
PENDING_SETUP, ACTIVE, INACTIVE, FINISHING, ARCHIVED Return templates created strictly before this timestamp.
Return templates created strictly after this timestamp.
Response
Successful Response
Records on this page.
Hide child attributes
Hide child attributes
Unique identifier.
Name of the template.
Short description of what the template is for.
Lifecycle state.
PENDING_SETUP, ACTIVE, INACTIVE, FINISHING, ARCHIVED Number of steps configured on the template.
BCP-47 language tag the template was authored in.
IANA timezone the template's send-window rules are evaluated in.
When the template was first activated.
When the template was created.
When the template last changed.
Total number of records matching the query.
Total number of pages.
Whether more pages remain after the current one.
Was this page helpful?
curl --request GET \
--url https://api.topo.io/v1/sequence-templates \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topo.io/v1/sequence-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/sequence-templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"summary": "<string>",
"status": "PENDING_SETUP",
"step_count": 123,
"language": "<string>",
"timezone": "<string>",
"activated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total_count": 123,
"total_pages": 123,
"has_more": true
}