Segment is a Customer Data Platform (CDP) that allows you to easily collect, transform, send, and archive your first-party customer data. Connect with Segment to build custom internal tools to manage your Segment Workspaces and resources like Sources, Destinations, and Warehouses.
To get started you'll need a Segment API token. To create an API token:
Once you have an access token, you're ready to set up your Superblocks integration.
Once your Segment integration is created, you can start creating steps in Application backend APIs, Workflows, and Scheduled Jobs to call Segment API actions. Segment actions are REST requests. To learn more about REST requests in Superblocks, see the Building REST requests guide.
Add Connection from Source to Warehouse
Connects a Source to a Warehouse.
• When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail).
Remove Source Connection from Warehouse
Disconnects a Source from a Warehouse.Add Labels to Source
Adds an existing label to a Source.
• When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail).
Replace Labels in Source
Replaces all labels in a Source.Add Permissions to User
Adds a list of access permissions to a user.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Policy Created
* User Policy Updated
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Replace Permissions for User
Updates the list of access permissions for a user.
• When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Add Permissions to User Group
Adds a list of access permissions to a user group.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Policy Created
* User Group Policy Updated
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Replace Permissions for User Group
Updates the list of access permissions for a user group.
• When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Sources from Tracking Plan
Lists Sources connected to a Tracking Plan.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
This endpoint requires the user to have at least the following permission(s):
* Source Read-only
* Tracking Plan Read-onlyAdd Source to Tracking Plan
Connects a Source to a Tracking Plan.
• When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail).
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Remove Source from Tracking Plan
Disconnects a Source from a Tracking Plan.
• When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail).
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.List Users from User Group
Returns users belonging to a user group.Add Users to User Group
Adds a list of users or invites to a user group.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Subjects Added to Group
* User Added To User Group
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Batch Query Messaging Subscriptions for Space
Get Messaging Subscriptions for space.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.Create Cloud Source Regulation
Creates a Source-scoped regulation.
Config API omitted fields:
- `attributes`,
- `userAgent`
List Destinations
Returns a list of Destinations.Create Destination
Creates a new Destination.
• When called, this endpoint may generate the `Integration Created` event in the [audit trail](/tag/Audit-Trail).
List Subscriptions from Destination
Lists subscriptions for a Destination.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.Create Destination Subscription
Creates a new Destination subscription.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.Create Edge Functions
Create EdgeFunctions for your Source given a valid upload URL for an Edge Functions bundle.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.List Filters from Destination
Lists filters for a Destination.Create Filter for Destination
Creates a filter in a Destination.
• When called, this endpoint may generate the `Destination Filter Created` event in the [audit trail](/tag/Audit-Trail).
List Functions
Lists all Functions in a Workspace.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Create Function
Creates a Function.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Create Function Deployment
Deploys a Function. Only applicable to Source Function instances.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.List Insert Function Instances
Lists all insert Function instances connected to the given insert Function.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Create Insert Function Instance
Creates an insert Function instance connected to the given Destination.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.List Invites
Returns a list of invitations to join a Workspace.
Config API omitted fields:
- `parent`
Create Invites
Invites a list of users to join a Workspace.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Non-Segment User Invited to Workspace
* Policy Created
* New Segment User Invited to Workspace
Config API omitted fields:
- `parent`
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Delete Invites
Removes a list of invitations to join a Workspace.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Invite Deleted
* Group Memberships Deleted
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Labels
Returns a list of all available labels.Create Label
Creates a new label.
• When called, this endpoint may generate the `Label Created` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Profiles Warehouse in Space
Lists all Profile Warehouses for a given space id.
• When called, this endpoint may generate the `Profiles Sync Warehouse Retrieved` event in the [audit trail](/tag/Audit-Trail).
Create Profiles Warehouse
Creates a new Profiles Warehouse.
• When called, this endpoint may generate the `Profiles Sync Warehouse Created` event in the [audit trail](/tag/Audit-Trail).
List Reverse Etl Models
Returns a list of Reverse ETL Models.Create Reverse Etl Model
Creates a new Reverse ETL Model.
• When called, this endpoint may generate the `Model Created` event in the [audit trail](/tag/Audit-Trail).
List Sources
Returns a list of Sources.Create Source
Creates a new Source.
• When called, this endpoint may generate the `Source Created` event in the [audit trail](/tag/Audit-Trail).
List Regulations from Source
Lists all Source-scoped regulations.Create Source Regulation
Creates a Source-scoped regulation.
• When called, this endpoint may generate the `Source Regulation Created` event in the [audit trail](/tag/Audit-Trail).
Config API omitted fields:
- `attributes`,
- `userAgent`
List Tracking Plans
Returns a list of Tracking Plans.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Create Tracking Plan
Creates a Tracking Plan.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.List Transformations
Lists all Transformations in the Workspace.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Create Transformation
Creates a new Transformation.
• When called, this endpoint may generate the `Transformation Created` event in the [audit trail](/tag/Audit-Trail).
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.List User Groups
Returns all user groups.Create User Group
Creates a user group.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* User Group Created
* Policy Created
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Create Validation in Warehouse
Validates input settings against a Warehouse.
• When called, this endpoint may generate the `Storage Destination Settings Validation` event in the [audit trail](/tag/Audit-Trail).
List Warehouses
Returns a list of Warehouses.Create Warehouse
Creates a new Warehouse.
• When called, this endpoint may generate the `Storage Destination Created` event in the [audit trail](/tag/Audit-Trail).
List Workspace Regulations
Lists all Workspace-scoped regulations.Create Workspace Regulation
Creates a Workspace-scoped regulation.
• When called, this endpoint may generate the `Workspace Regulation Created` event in the [audit trail](/tag/Audit-Trail).
Config API omitted fields:
- `attributes`,
- `userAgent`
Get Destination
Returns a Destination by its id.
Config API omitted fields:
- `catalogId`
Update Destination
Updates an existing Destination.
**Note**: if you attempt to update read-only settings for your destination you'll encounter the following behavior:
* If only read-only properties are being updated, the endpoint will return an HTTP 400 error.
* If there's a mix of writable and read-only properties in the payload, the request will be accepted, the writable properties will be updated and the read-only properties ignored.
• When called, this endpoint may generate the `Integration Disabled` event in the [audit trail](/tag/Audit-Trail).
Config API omitted fields:
- `updateMask`
Delete Destination
Deletes an existing Destination.
• When called, this endpoint may generate the `Integration Deleted` event in the [audit trail](/tag/Audit-Trail).
Config API omitted fields:
- `catalogId`
Get Function
Gets a Function.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Update Function
Updates a Function.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
Config API omitted fields:
- `updateMask`
Delete Function
Deletes a Function.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Update Insert Function Instance
Updates an insert Function instance connected to the given Destination.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Delete Insert Function Instance
Deletes an insert Function instance.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Delete Label
Deletes a label.
• When called, this endpoint may generate the `Label Deleted` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Get Regulation
Gets a regulation from the Workspace.
Config API omitted fields:
- `parent`
Delete Regulation
Deletes a regulation from the Workspace. The regulation must be in the initialized state to be deleted.
• When called, this endpoint may generate the `Regulation Deleted` event in the [audit trail](/tag/Audit-Trail).
Get Reverse Etl Model
Returns a Reverse ETL Model by its id.Update Reverse Etl Model
Updates an existing Reverse ETL Model.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Model Settings Saved
* Model State Change Toggled
Delete Reverse Etl Model
Deletes an existing Model.
• When called, this endpoint may generate the `Model Deleted` event in the [audit trail](/tag/Audit-Trail).
Get Source
Returns a Source by its id.Update Source
Updates an existing Source.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Source Modified
* Source Enabled
* Source Settings Modified
* Source Disabled
Config API omitted fields:
- `updateMask`
Delete Source
Deletes an existing Source.
• When called, this endpoint may generate the `Source Deleted` event in the [audit trail](/tag/Audit-Trail).
Get Tracking Plan
Returns a Tracking Plan.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Update Tracking Plan
Updates a Tracking Plan.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
Config API omitted fields:
- `updateMask`
Delete Tracking Plan
Deletes a Tracking Plan.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Get Transformation
Gets a Transformation.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Update Transformation
Updates an existing Transformation.
• When called, this endpoint may generate the `Transformation Updated` event in the [audit trail](/tag/Audit-Trail).
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Delete Transformation
Deletes a Transformation.
• When called, this endpoint may generate the `Transformation Deleted` event in the [audit trail](/tag/Audit-Trail).
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Get User Group
Returns a user group.Update User Group
Updates a user group for a Workspace.
• When called, this endpoint may generate the `User Group Updated` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Delete User Group
Removes a user group from a Workspace.
• When called, this endpoint may generate the `User Group Deleted` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Users
Returns a list of users with access to the Workspace.Delete Users
Removes one or multiple users.
• When called, this endpoint may generate the `Group Memberships Deleted` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Get Warehouse
Returns a Warehouse by its id.Update Warehouse
Updates an existing Warehouse.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Storage Destination Modified
* Storage Destination Enabled
Delete Warehouse
Deletes an existing Warehouse.
• When called, this endpoint may generate the `Storage Destination Deleted` event in the [audit trail](/tag/Audit-Trail).
Disable Edge Functions
Disable Edge Functions for your Source.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.Echo
Public Echo endpoint.Generate Upload URL for Edge Functions
Generate a temporary upload URL that can be used to upload an Edge Functions bundle.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.Get Advanced Sync Schedule from Warehouse
Returns the advanced sync schedule for a Warehouse.
The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Replace Advanced Sync Schedule for Warehouse
Updates the advanced sync schedule for a Warehouse, replacing the sync schedule with a new schedule.
The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Get Audience
Returns the Audience by id and spaceId.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.
The rate limit for this endpoint is 100 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Update Audience for Space
Updates the enabled status for an audience
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.
• When called, this endpoint may generate the `Audience Modified` event in the [audit trail](/tag/Audit-Trail).
• Note that when an Audience is updated, the Audience will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/engage/audiences/#editing-realtime-audiences-and-traits).
The rate limit for this endpoint is 10 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Remove Audience from Space
Deletes an Audience by id and spaceId.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.
• When called, this endpoint may generate the `Audience Deleted` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Get Computed Trait
Returns the Computed Trait by id and spaceId
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information.
The rate limit for this endpoint is 100 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Update Computed Trait for Space
Updates the enabled status for a computed trait.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information.
• When called, this endpoint may generate the `Computed Trait Modified` event in the [audit trail](/tag/Audit-Trail).
• Note that when a Computed Trait is updated, the Computed Trait will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/unify/traits/computed-traits/#editing-realtime-traits).
The rate limit for this endpoint is 10 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Remove Computed Trait from Space
Deletes a Computed Trait by id and spaceId.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information.
• When called, this endpoint may generate the `Computed Trait Deleted` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Get Connection State from Warehouse
Verifies the state of Warehouse connection settings.
The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Get Daily Per Source API Calls Usage
Provides daily cumulative per-source API call counts for a usage period.Get Daily Per Source MTU Usage
Provides daily cumulative per-source MTU counts for a usage period.Get Daily Workspace API Calls Usage
Provides daily cumulative API call counts for a usage period.Get Daily Workspace MTU Usage
Provides daily cumulative MTU counts for a usage period.Get Destination Metadata
Returns a Destination catalog item by its id.Get Destinations Catalog
Returns a list of all available Destinations in the Segment catalog.Get Events Volume from Workspace
Enumerates the Workspace event volumes over time in minute increments.
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Get Filter in Destination
Gets a Destination filter by id.Update Filter for Destination
Updates a filter in a Destination.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Destination Filter Enabled
* Destination Filter Disabled
Remove Filter from Destination
Deletes a Destination filter.
• When called, this endpoint may generate the `Destination Filter Deleted` event in the [audit trail](/tag/Audit-Trail).
Get Function Version
Gets a Function version.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Get Latest from Edge Functions
Get the latest Edge Functions for your Source.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.Get Source Metadata
Returns a Source catalog item by its id.Get Sources Catalog
Returns a list of all available Sources in the Segment catalog.Get Space
Returns the Space by id.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.Get Subscription from Destination
Gets a Destination subscription by id.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.Update Subscription for Destination
Updates an existing Destination subscription.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.Remove Subscription from Destination
Deletes an existing Destination subscription.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.Get User
Returns a user given their id.Get Warehouse Metadata
Returns a Warehouse catalog item by its id.Get Warehouses Catalog
Returns a list of all available Warehouses in the Segment catalog.Get Workspace
Returns the Workspace associated with the token used to access this resource.List Audiences
Returns Audiences by spaceId.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.
The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Audit Events
Returns a list of Audit Trail events.List Computed Traits
Returns Computed Traits by spaceId.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information.
The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Connected Destinations from Source
Returns a list of Destinations connected to a Source.List Connected Sources from Warehouse
Returns the list of Sources that are connected to a Warehouse.List Connected Warehouses from Source
Returns a list of Warehouses connected to a Source.List Delivery Metrics Summary from Destination
Get an event delivery metrics summary from a Destination.
Based on the granularity chosen, there are restrictions on the time range you can query:
**Minute**:
- Max time range: 4 hours
- Oldest possible start time: 48 hours in the past
**Hour**:
- Max Time range: 7 days
- Oldest possible start time: 7 days in the past
**Day**:
- Max time range: 14 days
- Oldest possible start time: 14 days in the past
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Function Versions
Lists versions for a Function in a Workspace.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.Restore Function Version
Restore an old Function version as the latest version.
• In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.List Invites from User Group
Returns the emails of invitees to a user group.List Roles
Returns a list of Roles available to apply to permissions for users and/or groups.List Rules from Tracking Plan
Lists Tracking Plan rules.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Replace Rules in Tracking Plan
Replaces Tracking Plan rules.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Update Rules in Tracking Plan
Updates Tracking Plan rules.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.Remove Rules from Tracking Plan
Deletes Tracking Plan rules.
• In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.List Schema Settings in Source
Retrieves the schema configuration settings for a Source. If Protocols is not enabled for the Source, the configurations specific to Protocols will have default values.Update Schema Settings in Source
Updates the schema configuration for a Source. If Protocols is not enabled for the Source, any updates to Protocols-specific configurations will not be applied.
Config API omitted fields:
- `updateMask`
List Selective Syncs from Warehouse And Source
Returns the schema for a Warehouse, including Sources, Collections, and Properties.
The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Selective Syncs from Warehouse And Space
Returns the schema for a Space Warehouse connection, including Collections and Properties.Update Selective Sync for Warehouse And Space
Updates the schema for a Space Warehouse connection, including Collections and Properties.
• When called, this endpoint may generate the `Profiles Sync Warehouse Modified` event in the [audit trail](/tag/Audit-Trail).
List Suppressions
Lists all suppressions in a given Workspace.List Syncs from Warehouse
Returns the overview of syncs for every Source connected to a Warehouse.
The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List Syncs from Warehouse And Source
Returns the overview of syncs for a Source connected to a Warehouse.
The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.List User Groups from User
Returns all groups a user belongs to.Preview Destination Filter
Simulates the application of a Destination filter to a provided JSON payload.Update Profiles Warehouse for Space Warehouse
Updates an existing Profiles Warehouse.
• When called, this endpoint may generate the `Profiles Sync Warehouse Updated` event in the [audit trail](/tag/Audit-Trail).
Remove Profiles Warehouse from Space
Deletes an existing Profiles Warehouse.
• When called, this endpoint may generate the `Profiles Sync Warehouse Deleted` event in the [audit trail](/tag/Audit-Trail).
Replace Users in User Group
Replaces the members of a user group by email.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Subjects Added to Group
* User Added To User Group
* Group Memberships Deleted
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Remove Users from User Group
Removes one or multiple users or invites from a user group by email.
• When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Group Memberships Deleted
* User Removed From User Group
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Replace Messaging Subscriptions in Spaces
Replace Messaging Subscriptions in Spaces.
• This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com.
• In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.
The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.Update Selective Sync for Warehouse
Configures the schema for a Warehouse, including Sources, Collections, and Properties.
• When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail).
The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.and 132 moreTo use this action simply add the method, path, required query parameters, and body for the desired endpoint.
