Whatfix Segments API
The Segments API from Whatfix — 1 operation(s) for segments.
Whatfix Segments API is one of 5 APIs that Whatfix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Segments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version v1.
Requests are made against a single base URL, https://whatfix.com/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Whatfix Segments API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-whatfix-integration-key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— User API token obtained from the Whatfix dashboard. Pass your registered Whatfix email address in the x-whatfix-user header as well.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Segment (5 properties), Pagination (4 properties), Error (3 properties), SegmentList (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Whatfix 4
Other APIs Whatfix publishes across the network.