Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 3.0.0
title: Opal API (⚠️ WIP) Channels API
license:
name: Opal API License
url: https://www.workwithopal.com/api-license
description: "The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [[RFC2119](https://tools.ietf.org/html/rfc2119)] [[RFC8174](https://tools.ietf.org/html/rfc8174)] when, and only when, they appear in all capitals, as shown here.\n\n# Other API Versions\n\nThe [v2 API](/api/documentation/v2) is more complete than the v3 API. Currently, if a resource has endpoints in both the v2 API and the v3 API you **SHOULD** use the v2 API endpoints. At some point in the future we will recommend the v3 API instead.\n\n*Note:* Endpoints will be added to the v3 API as needed, and we will continue to support all v2 API endpoints in the “JSON:API” and “Other” categories, even if we add an equivalent v3 API endpoint.\n\n# Key differences between v2 and v3 APIs\n\n## Resource Identifiers\n\nThe v3 API uses a different format for primary resource identifiers than the v2 API. Responses from v3 API endpoints include the resource’s v2 API id in the `attributes.legacy_id` field, in case you need to use both API versions. (v2 API resource identifiers are generally integers, but v2 API endpoints **MAY** use a different format.)\n\n*Note:* These are opaque strings, and you **MUST NOT** rely on the structure. Currently newly-created resources have a UUIDv4 identifier, but this behavior **MAY** change at any time. Existing identifiers will not be affected.\n\n# Documentation Organization\n\nv3 API endpoints are categorized by stability:\n\n1. Stable\n2. Unstable\n3. Proposed\n4. Experimental\n\nAll v3 API endpoints are [JSON:API](https://jsonapi.org)-compliant ([specification](https://jsonapi.org/format/)) and can be used with any [JSON:API-compliant client](https://jsonapi.org/implementations/).\n\nYour requests **MUST** set the `Accept` HTTP header to `application/vnd.api+json`. The server response’s `Content-Type` HTTP header will also be `application/vnd.api+json`.\n\n## Unstable Endpoints\n\n*Note:* This generally refers resources in the “Unstable” category, but includes endpoints with a summary that’s prefixed by `[UNSTABLE]`. These `[UNSTABLE]` endpoints may be part of a “Stable” resource.\n\nThe data structure and behavior of “Unstable” endpoints are not guaranteed, and we **MAY** change them at any time. You **MUST NOT** use these endpoints for production features, but **MAY** use them as a preview of upcoming features, and we welcome feedback.\n\n## Proposed Endpoints\n\n“Proposed” endpoints **MUST NOT** be used (they’re not yet implemented), and we **MAY** change or remove them at any time. We publish them at our discretion to share our plans and encourage internal feedback. We also welcome your feedback.\n\n# Design Principles\n\n## Breaking Changes\n\nWe **MAY** expand the data for “Stable” resources, but will not change or remove existing attributes or relationships for these resources. These expansions should not require any changes to your code.\n\nWe provide no guarantees for “Unstable,” \"Experimental,\" or “Proposed” endpoints.\n\n## Firehose Rule\n\nBy default endpoints include all the relevant data that’s accessible to the authenticated user. Clients **MAY** specify filters, ordering, pagination, sparse fields, and other limiting mechanisms to pare down the desired data.\n\n*Note:* Existing endpoints **MAY NOT** follow this maximalist approach, but new endpoints will, and we **MAY** enhance existing endpoints.\n\n## Obscurity\n\nIn order to provide customers with as much privacy as possible, many API calls that fail authorization will return `404 Not Found` rather than `403 Forbidden`. Do not design frontends around the expectation that a `404 Not Found` status code means a resource would not be returned given different authentication credentials.\n\n# Authentication Strategies\n## OAuth 2.0\nOpal uses OAuth 2.0 (https://oauth.net/2) to authenticate users and grant access to protected resources. After registering your application as an OAuth client, you must get permission from each user before accessing their account.\n\nThe main steps are:\n\n1. Register your application\n2. Direct the user to Opal, to authorize your application\n3. Opal confirm's user identity, and asks the user to grant your application permissions\n4. Opal issues tokens your application can use to access the user's Opal resources\n5. Your application can begin making requests to the Opal API on behalf of the user\n\n### Roles\n#### Client\nThe 3rd-party application accessing the API on behalf of the User.\n\n#### API\nAPI endpoints used to interact with a User's resources in Opal.\n\n#### User\nThe person authorizing the Client to access to their Opal account.\n\n### Registering your application\nApplication registration is currently a manual process.\n\nTo begin, you will need to provide the following information to the Opal integrations team:\n\n- Application name\n- Logo URI\n- Redirect URI\n\nIn return, expect to receive:\n\n- Client ID\n - public\n- Application secret\n - keep this private\n - keep this written down someplace safe. Opal cannot retrieve this for you if it is lost.\n\n### Authorization\nFor a Client to make API requests on behalf of Users, the User must first give consent.\nHere is an overview of the consent flow:\n\n1. Direct the User to grant access in Opal\n\n```\nhttps://login.ouropal.com/oauth2/auth?grant_type=authorization_code&scope=offline_access&response_type=code&client_id={client_id}&state={state}&redirect_uri={url_encoded_redirect}\n```\n\nParameters:\n- `client_id`: Provided by Opal.\n- `grant_type`: Set the value to authorization_code to receive a code string that can be exchanged for an access token.\n- `redirect_uri`: Defined by Client. After authentication, the user will be directed to this location.\n- `response_type`: The value code should be set for refresh tokens to be issued.\n- `scope`: The value offline_access must be present if you wish to use refresh tokens.\n- `state`: Defined by the Client. A unique value used to validate the response.\n\n\n2. If logged out, User is directed to log in to Opal\n\n3. User is redirected to consent page (if the User has not already given consent)\n\n```\nhttps://login.ouropal.com/oauth2/consent?consent_challenge=abc123\n```\n\n4. If the User grants permission, User is sent to the specified `redirect_uri`\n\n```\nhttps://example.com/defined-by-client?code=Mu9z2DndN7TfXSLaf99O8ReqqXqMabXhSqP5e0jlx_Q.naLKbko-GyfPJRGYcWyclxU0sBGwygPy05OSFww0XZ8&scope=offline_access&state={state}\n```\n\nParameters:\n- `code`: The Client may use this to get an access token.\n- `scope`: API permissions granted to the Client by the User.\n- `state`: The validation string provided by the Client in step 1.\n\nIf the User declines the consent prompt, User will be sent to the same `redirect_uri`, but with an error parameter :\n\n```\nhttps://example.com/defined-by-client?error=consent+request+denied&state={state}\n```\n\nParameters:\n- `error`: A brief description of the issue.\n- `state`: The validation string provided by the Client in step 1.\n\n### Retrieving Access Token\nYou must make a POST request to the token endpoint to get an access token, before the code expires:\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'code={code}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={client_secret}&grant_type=authorization_code'\n```\n\nParameters:\n- `code`\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to authorization_code .\n- `redirect_uri`: Optional.\n\nIf successful, a JSON-formatted response body will contain the access_token and refresh_token:\n\n```json\n{\n \"access_token\":\"ABC123\",\n \"token_type\":\"bearer\",\n \"expires_in\":3600,\n \"refresh_token\":\"DEF456\",\n \"scope\":\"offline_access\"\n}\n```\n\n### Refreshing an Access Token\nOnce the access_token expires, you may generate a new one at the same token endpoint, but with different parameters.\nNote that in this request, a \"refresh_token\" parameter is used instead of \"code\", and the \"grant_type\" value is now \"refresh_token\" instead of \"authorization_code\".\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'refresh_token={refresh_token}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={secret}&grant_type=refresh_token'\n```\n\nParameters:\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to refresh_token .\n- `redirect_uri`: Optional.\n- `refresh_token`: Refresh token value\n\n### Making Authenticated Requests\n\nSet an authorization header in your requests, specifying your access token as documented here: https://tools.ietf.org/html/rfc6750#section-2.1.\n\n**NOTE** that the `Authorization` header supercedes the `Session-Token` header described in the documentation for many endpoints. Specifying an `Authorization` header means you do not need to specify a `Session-Token` header.\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nFor example:\n```\n GET /resource HTTP/1.1\n Host: server.example.com\n Authorization: Bearer mF_9.B5f-4.1JqM\n```\n\n### Client Revoke/Rolling OAuth secrets\nClient secrets must be kept secret and not exposed outside of the token retrieval requests. If a secret has been potentially compromised, please notify Opal as soon as possible and let us know the OAuth client id associated with the secret. We will roll/update the secret, which will invalidate all existing access and refresh tokens. Invalidating tokens will cause users to need to reauthenticate, but consent should be remembered.\n"
servers:
- url: https://login.ouropal.com
tags:
- name: Channels
paths:
/v3/channels:
get:
tags:
- Channels
operationId: ReadChannelsV3
summary: '[UNSTABLE] Get Channels available to the authenticated user.'
security:
- oauth2:
- offline_access
- api_key: []
parameters:
- name: filter
in: query
description: 'Filters for limiting the results.
All timestamp filters (`created_at`, `updated_at`, and `scheduled_at`), use syntax `filter[field_name][gt]=2020-01-01T00:00:00-07:00`
Timestamps use iso8601 formatting, such as `YYYY-MM-DD` or `YYYY-MM-DDThh:mmTZD`.Timestamps of the form `YYYY-MM-DD` will be converted to `YYY-MM-DDT00:00:00` in the `America/Los_Angeles` timezone.
If no operator is specified, `eq` will be assumed. For example, `filter[created_at]=2020-01-01` is equivalent to `filter[created_at][gteq]=2020-01-01`. `eq` will convert a date to a 24 hour range.Thus `filter[created_at][eq]=2020-01-01` is equivalent to `filter[created_at][gteq]=2020-01-01T00:00:00-08:00&filter[created_at][lteq]=2020-01-02T00:00:00-08:00`.
'
required: false
schema:
type: object
properties:
workspace_id:
type: array
description: 'The IDs of the workspaces to which results should be filtered.
Comma separated list of IDs. If included, will only fetch resources associated with these workspaces. If not included, will return resources associated with all workspaces that the user belongs to. For example, `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch all resources associated with workspace `798ac6d9-b3fc-4155-88ee-237f43f3404b`, while `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b,d79e513e-9246-454e-80bf-8268bc39cd6e,f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed` will fetch any resources associated with workspaces `798ac6d9-b3fc-4155-88ee-237f43f3404b`, `d79e513e-9246-454e-80bf-8268bc39cd6e`, or `f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed`.
'
items:
type: string
format: uuid
created_at:
allOf:
- type: object
properties:
eq:
type: string
description: 'Equal to filter. If no other filter is specified, `eq` will be assumed.
'
gt:
type: string
description: Greater than filter
gteq:
type: string
description: Greater than or equal to filter
lt:
type: string
description: Less than filter
lteq:
type: string
description: Less than or equal to filter
- format: date-time
description: 'Filter by the channel created_at time. Uses syntax `filter[created_at][gt]=2020-01-01T00:00:00-07:00`.
'
updated_at:
allOf:
- type: object
properties:
eq:
type: string
description: 'Equal to filter. If no other filter is specified, `eq` will be assumed.
'
gt:
type: string
description: Greater than filter
gteq:
type: string
description: Greater than or equal to filter
lt:
type: string
description: Less than filter
lteq:
type: string
description: Less than or equal to filter
- format: date
description: 'Filter by the channel updated_at time. Uses syntax `filter[updated_at][gt]=2020-01-01T00:00:00-07:00`.
'
style: deepObject
explode: true
- name: include
in: query
required: false
description: A comma separated value of related objects to include.
schema:
type: array
items:
type: string
enum:
- content_types
style: form
explode: false
- name: sort
in: query
description: 'A comma separated value specifying how a collection in the response body
should be sorted, where each value is an attribute of the channel. When
specifying multiple values, each value in the sequence determines the
ordering precedence.
Each channel in the collection will appear in ascending order, unless
any of the enumerated values are prefixed with a minus "-" sign, in
which case each channel will appear in descending order for the
specified values.
'
required: false
schema:
type: string
enum:
- created_at
- updated_at
- name: page
description: Specify an offset and limit for pagination
in: query
required: false
schema:
type: object
properties:
limit:
type: integer
default: 50
offset:
type: integer
style: deepObject
explode: true
responses:
'200':
description: A collection of channels.
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
title: channel
type: object
required:
- id
- type
- attributes
- relationships
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- channel
attributes:
type: object
required:
- color
- content_name
- created_at
- has_placements
- icon_name
- icon_path
- is_active
- is_visible
- legacy_id
- name
- system_name
- updated_at
- web_modules_channel
additionalProperties: false
properties:
color:
type: string
description: A hex color value with leading hash symbol intact
content_name:
type: string
description: The default name of content for this channel
created_at:
type: string
format: date-time
description: An ISO8601 date-time indicating when the channel was created.
readOnly: true
has_placements:
type:
- boolean
- 'null'
description: Indicates if the channel supports placements capability
icon_name:
type:
- string
- 'null'
icon_path:
type:
- string
- 'null'
is_active:
type: boolean
description: Indicates active status of the channel
is_visible:
type: boolean
description: Indicates visibility of the channel
legacy_id:
type: string
description: The ID of the resource in the `v2` APIs.
name:
type: string
description: The name of the channel
system_name:
type: string
description: The unique system name of the channel
updated_at:
type: string
format: date-time
description: An ISO8601 date-time indicating when the channel was last updated.
readOnly: true
web_modules_channel:
type:
- boolean
- 'null'
description: Indicates if the channel is of the category "web modules"
relationships:
type: object
required:
- asset_reference
- content_types
- workspace
additionalProperties: false
properties:
asset_reference:
type: object
required:
- data
additionalProperties: false
properties:
data:
type:
- object
- 'null'
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- asset_reference
content_types:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- content_type
workspace:
type: object
required:
- data
additionalProperties: false
properties:
data:
type:
- object
- 'null'
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- workspace
included:
type: array
items:
oneOf:
- title: content_type
type: object
required:
- id
- type
- attributes
- relationships
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- content_type
attributes:
type: object
required:
- legacy_id
- created_at
- updated_at
- name
- system_name
additionalProperties: false
properties:
legacy_id:
type: string
description: An ID that can be used with `v2` APIs.
created_at:
type: string
format: date-time
description: An ISO8601 date-time.
readOnly: true
updated_at:
type: string
format: date-time
description: An ISO8601 date-time.
readOnly: true
name:
type: string
description: The name of the Post Type
system_name:
type: string
description: The unique name used to look up a Post Type
relationships:
type: object
required:
- workspace
- opal
additionalProperties: false
properties:
workspace:
type: object
required:
- data
additionalProperties: false
properties:
data:
type:
- object
- 'null'
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- workspace
opal:
type: object
required:
- data
additionalProperties: false
properties:
data:
type:
- object
- 'null'
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- opal
meta:
type: object
required:
- total
- page
- resource_type
properties:
resource_type:
type: string
total:
type: integer
page:
type: object
required:
- limit
- offset
properties:
limit:
type: integer
offset:
type: integer
example:
data:
- id: 9480a66e-2d02-4a09-959b-a317b7e6cf5f
type: channel
attributes:
color: '#7FC3C5'
content_name: Email
created_at: '2026-04-20T15:27:01.881-08:00'
has_placements: false
icon_name: email
icon_path: M13,16 L15,16...Z
is_active: true
is_visible: true
legacy_id: '1'
name: Email
system_name: email
updated_at: '2026-04-20T15:27:01.881-08:00'
web_modules_channel: false
relationships:
workspace:
data: null
asset_reference:
data: null
content_types:
data:
- id: 1aaf0da8-8f5b-442f-a705-648f2fe0b10c
type: content_type
meta:
total: 1
page:
limit: 25
offset: 0
resource_type: channel
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
description: The http status code of the error response.
title:
type: string
description: A short, human-readable summary of the error.
detail:
type: string
description: A human-readable explanation of the error.
code:
type: string
description: 'An system-readable error code to provide additional specificity for
the error.
'
required:
- status
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
required:
- errors
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
description: The http status code of the error response.
title:
type: string
description: A short, human-readable summary of the error.
detail:
type: string
description: A human-readable explanation of the error.
code:
type: string
description: 'An system-readable error code to provide additional specificity for
the error.
'
required:
- status
'422':
description: Unprocessable entity
content:
application/json:
schema:
type: object
required:
- errors
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
description: The http status code of the error response.
title:
type: string
description: A short, human-readable summary of the error.
detail:
type: string
description: A human-readable explanation of the error.
code:
type: string
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-channels-api-openapi.yml