| Endpoint essentials | |
|---|---|
| API key access | api/v1/emailer_campaigns/search or Master API key |
| OAuth scopes | emailer_campaigns_search |
| Credit usage | 0 creditsLearn more about API pricing and credits. |
Sequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.
Use the Search for Sequences endpoint to search for the sequences that have been created for your team's Apollo account.
Each sequence in the response includes a sharing_permission object that describes who can access it. This object replaced the legacy permissions field, which is no longer returned by any sequence endpoint. Read sharing_permission as follows, for team members who don't hold a permission profile that grants access to every sequence in the workspace:
| Sequence access | Values returned |
|---|---|
Only the owner, plus anyone listed in sharing_accesses | visibility: restricted, access_type: null |
| The whole team can view the sequence | visibility: everyone, access_type: can_view |
| The whole team can use and edit the sequence | visibility: everyone, access_type: can_edit or full_access |
The owner_id field matches the sequence's user_id, and is_owner tells you whether the authenticated user owns the sequence.
Permission profiles can widen this. A team member whose profile lets them view and edit all sequences can access a restricted sequence they don't own and that was never explicitly shared with them, so treat the table above as the baseline rather than a hard boundary.
To change a sequence's sharing, call the Update a Sequence endpoint with the sharing_permission object.