Sequences

This object represents a sequence within your organization. A sequence is an onboarding or workflow container made up of ordered steps, and each step can reference a specific requirement such as a form and waiver, interview, training, orientation, or onboarding document.

If you're not familiar with Vome's system, the hierarchy works as follows: Sequence > Step

Each sequence stores the key details used to describe it, including its title, description, status, visibility, and related step information. Returned sequence data includes the ordered step_info array, where each step contains its step number, type, and step-specific details.

You can use the Sequences API to list all sequences for your institution, retrieve a single sequence by ID, or search sequences using filters such as title, description, status, display status, and created date.

Endpoints

GET /api/sequences/ GET /api/sequences/{sequence_id}/ GET /api/sequences/search/