List segments with the Omnisend API
Lists the segments with their segmentID, name and status. The segmentID targets campaigns and filters contacts. The response has segments and paging; while paging.hasMore is true, pass paging.cursors.after as after.
- Identifier
- omnisend_list_segments
The request
POST https://connect.reportei.com/api/tools/omnisend_list_segments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"sort": "createdAt"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| sort | string | No | Field to sort by, on the first page only.Values: createdAt, name |
| direction | string | No | Order of the sort, used only with sort.Values: asc, desc |
| limit | integer | No | Segments per page, up to 50. |
| after | string | No | The paging.cursors.after of the previous page. |
Supported connections
Your customer connects their Omnisend account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/omnisend_list_segments. It becomes your agent's tool definition with no conversion.
Other Omnisend tools
- List contactsGETLists the contacts with their id, email, phone, status, tags, segments and custom properties, newest first by default. The response has contacts and paging; while paging.hasMore is true, pass paging.cursors.after as after and keep the filters.
- Create contactPOSTCreates a contact, or updates the contact that already has the same email identifier. Setting a channel to subscribed sends the welcome message of the brand, when that automation is on, unless sendWelcomeMessage is false.
- Update contactPATCHUpdates a contact. Only the fields sent change, but tags replaces the whole list of tags: to only add tags, use Apply tags. A channel status in identifiers subscribes or unsubscribes the contact.
- Apply tagsPOSTAdds tags to contacts, keeping the tags they already have. Pick the contacts by contactIDs, emails, phones or segmentID; the selections add up. Limited to 60 calls per minute.
- List email templatesGETLists the email templates with their id and name, newest first by default. The id is the body of an email campaign. The response has templates and paging; while paging.hasMore is true, pass paging.cursors.after as after.
- List campaignsGETLists the campaigns with their id, name, status, channel, content, audience and sending settings, newest first by default. The response has campaigns and paging; while paging.hasMore is true, pass paging.cursors.after as after and keep the filters.
- Create campaignPOSTCreates a regular email or SMS campaign as a draft and returns it with its id. An email campaign needs content.email.templateID, from List email templates, and an SMS campaign needs content.sms. Nothing is sent until Send campaign.
- Update campaignPATCHUpdates a campaign in draft status. Only the fields sent change. The email template stays the one set at creation. To change a campaign that is no longer a draft, the app asks for a copy.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
