Public Open APIs
Welcome to the Public Open API documentation!
The Public Open APIs offer a unified interface for interacting with public OS APIs. These APIs are organized into groups designed to support specific functionalities and use cases. This guide provides an overview of the available API groups, their capabilities, and how to use them effectively. Whether you need to retrieve user data, explore workspace hierarchies, or interact with other system components, this documentation will help you understand and integrate the APIs seamlessly.
Users may need an authorization bearer token to authorize their access to make API calls using Swagger documentation.
App developers must pass the user's token (retrieved from the context object) when making API calls from their application.
If the API needs to be called outside of a user’s interaction—for example, in an async back-end process—developers may need to request the OIDC client credentials to generate a token on behalf of a service account user.
Users
The Users APIs let you retrieve information about users.
Utilize the group to search for users and retrieve information about them, including last name, first name, email address, agency, country, department, job title, office location, and others.
Workspace
The Workspace API provides access to information about WPP Workspaces—collaborative environments that integrate applications and resources. Although the name is legacy and retained for compatibility, this API allows you to query the hierarchical structure within a workspace. You can retrieve details about workspace entities, including their name, type, description, status, parent ID, related categories, associated countries, and hierarchical relationships. This includes understanding how a specific workspace fits within a broader structure, along with its ancestral connections.
Master Data
Master Data is a centralized place for managing common dictionaries in WPP Open. The MasterData API group provides information on business entities, including organizational entities, market segments, and geographical regions––the data that's core for strategic decision-making. Utilize the group to retrieve information on brands, agencies, clients, industries, geographies, markets, etc.
Notification
The Notification API group allows you to send messages to recipients within a workspace. These messages can alert users of updates, prompt action, or simply provide contextual feedback — whether triggered by user activity or system events (e.g. an overnight batch job).
Authentication & Token Handling
All Notification API requests require a Bearer token. If you're sending notifications outside a user session such as an async back-end process, use a Service Account token:
To get a service account token:
- Request an OIDC clientID/secret from your administrator.
- Use the credentials to generate a token.
Authorization : Bearer <access_token>
Example: Send a Notification
Request body
{
"title": "string",
"body": "string",
"recipients": [
{
"type": "USER",
"values": [
"[email protected]"
]
}
],
"deliveryChannels": [
"FEED"
]
}
Responses
| Code | Meaning | When it happens |
|---|---|---|
| 204 | Success | Notification sent successfully (no body retured) |
| 400 | Bad Request | Missing or malformed data (e.g., invalid JSON) |
| 404 | Not Found | Resource not found (e.g., recipient doesn't exist) |
| 422 | Validation Error | Data format is wrong (e.g., missing required fields) |
Validation error example (422):
{
"detail": [
{
"loc": ["body", "recipients", 0],
"msg": "Invalid recipient format",
"type": "value_error"
}
]
}
AI Assistant
The AI Assistant API group manages events or interactions with an AI assistant. Utilize the AI Assistant APIs to retrieve information on managing and coordinating tasks and subtasks performed by an AI assistant, confirming their schedules, execution, and receiving final and intermediary results once tasks or steps are completed.
These APIs require an Authorization header containing the user's access token.