Twilio Segment

segment Workspaces API

Operations for retrieving workspace information and configuration.

GitHub OpenAPI

Operations 2

GET /workspaces/{workspaceName} Get workspace #
GET /workspace Get workspace #

Documentation

📖
Documentation
https://docs.segmentapis.com/
📖
Documentation
https://www.twilio.com/docs/segment/connections/sources/catalog/libraries/server/http-api
📖
Documentation
https://www.twilio.com/docs/segment/unify/profile-api
📖
Documentation
https://www.twilio.com/docs/segment/api/config-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/segment/refs/heads/main/openapi/segment-workspaces-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/segment/refs/heads/main/asyncapi/segment-webhooks-asyncapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/segment/refs/heads/main/graphql/segment-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/segment-workspaces-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

segment-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Segment Workspaces API
  version: 1.0.0
  contact:
    name: Segment Support
    url: https://segment.com/help/
  termsOfService: https://segment.com/legal/terms/
  x-refined-note:
  - x-status differs across the merged source definitions and was not carried
  description: 'Operations tagged Workspaces across 2 of this provider''s published API definitions: segment-config-api-openapi.yml, segment-public-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://platform.segmentapis.com/v1beta
  description: Production Server (v1beta)
- url: https://api.segmentapis.com
  description: Production Server
security:
- bearerAuth: []
tags:
- name: Workspaces
  description: Operations for retrieving workspace information and configuration.
paths:
  /workspaces/{workspaceName}:
    get:
      operationId: getWorkspace
      summary: Get workspace
      description: Returns the workspace details for the specified workspace name.
      tags:
      - Workspaces
      parameters:
      - $ref: '#/components/parameters/WorkspaceName'
      responses:
        '200':
          description: Workspace retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://platform.segmentapis.com/v1beta
      description: Production Server (v1beta)
  /workspace:
    get:
      operationId: getWorkspace
      summary: Get workspace
      description: Returns the workspace associated with the access token used to make the request, including the workspace name, ID, and slug.
      tags:
      - Workspaces
      responses:
        '200':
          description: Workspace retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      workspace:
                        $ref: '#/components/schemas/Workspace_2'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    servers:
    - url: https://api.segmentapis.com
      description: Production Server
components:
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication credentials were missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The authenticated user does not have permission to access this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: The error type.
        message:
          type: string
          description: A human-readable error message.
    Workspace:
      type: object
      properties:
        name:
          type: string
          description: The fully qualified name of the workspace.
        display_name:
          type: string
          description: The display name of the workspace.
        id:
          type: string
          description: The unique identifier of the workspace.
        create_time:
          type: string
          format: date-time
          description: When the workspace was created.
    Error_2:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: The error type.
              message:
                type: string
                description: A human-readable error message.
              field:
                type: string
                description: The field that caused the error, if applicable.
              data:
                type: object
                description: Additional error data.
                additionalProperties: true
    Workspace_2:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the workspace.
        slug:
          type: string
          description: The URL-friendly slug of the workspace.
        name:
          type: string
          description: The display name of the workspace.
  parameters:
    WorkspaceName:
      name: workspaceName
      in: path
      required: true
      description: The name of the workspace.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Segment Config API access token. Note that as of early 2024, Segment has stopped issuing new Config API tokens.
x-refined-from:
- segment-config-api-openapi.yml
- segment-public-api-openapi.yml