- Warehouses
- Sources
- Migrate from the Config API
- postAdd Labels to Source
- putReplace Labels in Source
- postCreate Source
- getList Sources
- postCreate Write Key for Source
- delDelete Source
- getGet Source
- patchUpdate Source
- getList Connected Destinations from Source
- getList Connected Warehouses from Source
- getList Schema Settings in Source
- patchUpdate Schema Settings in Source
- delRemove Write Key from Source
- Deletion and Suppression
- Destinations
- Migrate from the Config API
- postCreate Destination
- getList Destinations
- postCreate Destination Subscription
- getList Subscriptions from Destination
- delDelete Destination
- getGet Destination
- patchUpdate Destination
- getGet Subscription from Destination
- delRemove Subscription from Destination
- patchUpdate Subscription for Destination
- getList Delivery Metrics Summary from Destination
- Edge Functions
- Destination Filters
- Use cases
- Availability
- Types of filters
- Filter order
- Conditional filters
- Universal filters
- Limits
- API models
- Action
- Migrate from the Config API
- Destination filter model
- Action model differences
- postCreate Filter for Destination
- getList Filters from Destination
- getGet Filter in Destination
- delRemove Filter from Destination
- patchUpdate Filter for Destination
- postPreview Destination Filter
- Functions
- Migrate from the Config API
- postCreate Function
- getList Functions
- postCreate Function Deployment
- postCreate Insert Function Instance
- getList Insert Function Instances
- delDelete Function
- getGet Function
- patchUpdate Function
- delDelete Insert Function Instance
- getGet Insert Function Instance
- patchUpdate Insert Function Instance
- getGet Function Version
- getList Function Versions
- postRestore Function Version
- Profiles Sync
- Reverse ETL
- Reverse ETL Sync schedule JSON configuration
- postCreate Reverse ETL Manual Sync
- postCreate Reverse Etl Model
- getList Reverse Etl Models
- delDelete Reverse Etl Model
- getGet Reverse Etl Model
- patchUpdate Reverse Etl Model
- getGet Reverse ETL Sync Status
- getList Reverse ETL Sync Statuses from Model And Subscription Id
- Selective Sync
- Catalog
- Delivery Overview
- getGet Egress Failed Metrics from Delivery Overview
- getGet Egress Success Metrics from Delivery Overview
- getGet Filtered At Destination Metrics from Delivery Overview
- getGet Filtered At Source Metrics from Delivery Overview
- getGet Ingress Failed Metrics from Delivery Overview
- getGet Ingress Success Metrics from Delivery Overview
- IAM Users
- IAM Groups
- postAdd Permissions to User Group
- putReplace Permissions for User Group
- postAdd Users to User Group
- getList Users from User Group
- postCreate User Group
- getList User Groups
- delDelete User Group
- getGet User Group
- patchUpdate User Group
- getList Invites from User Group
- delRemove Users from User Group
- putReplace Users in User Group
- Labels
- Audit Trail
- IAM Roles
- Tracking Plans
- Migrate from the Config API
- postAdd Source to Tracking Plan
- getList Sources from Tracking Plan
- delRemove Source from Tracking Plan
- postCreate Tracking Plan
- getList Tracking Plans
- delDelete Tracking Plan
- getGet Tracking Plan
- patchUpdate Tracking Plan
- getList Rules from Tracking Plan
- delRemove Rules from Tracking Plan
- putReplace Rules in Tracking Plan
- patchUpdate Rules in Tracking Plan
- Transformations
- Tracking Plans
Segment Public API (56.0.0)
Download OpenAPI specification:Download
Segment: friends@segment.com URL: https://docs.segmentapis.com
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs.
All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace.
See the next sections for more information on how to use the Segment Public API.