sequence-templates

Get Sequence Template

Fetch a single sequence template.

Requires the sequences:read scope on the API key.

get/v1/sequence-templates/{sequence_template_id}

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/sequence-templates/{sequence_template_id}
  • Auth: HTTP bearer

Path parameters

sequence_template_idstring uuid required

ID of the sequence template.

Response

Successful Response

idstring uuid required

Unique identifier.

namestring nullable required

Name of the template.

summarystring nullable required

Short description of what the template is for.

status'PENDING_SETUP' | 'ACTIVE' | 'INACTIVE' | 'FINISHING' | 'ARCHIVED' required
step_countinteger required

Number of steps configured on the template.

languagestring nullable required

BCP-47 language tag the template was authored in.

timezonestring required

IANA timezone the template's send-window rules are evaluated in.

activated_atstring date-time nullable required

When the template was first activated.

created_atstring date-time required

When the template was created.

updated_atstring date-time required

When the template last changed.

Changes

No recorded changes to this operation across all 30 revisions of this API.