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) Views 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: Views
paths:
/loupe/v3/views:
get:
tags:
- Views
operationId: ReadViewsV3
summary: Get the views available to the authenticated user for the given Workspace ID
security:
- oauth2:
- offline_access
- api_key: []
parameters:
- name: filter
in: query
description: 'Filters for limiting the results.
'
required: true
schema:
type: object
required:
- workspace_id
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
id:
type: array
description: 'The IDs of the resources that should be returned.
Comma separated list of IDs. If included, will only attempt to fetch resources matching those IDs. (Note that some or all resources may not be available.) If not included, will return all resources matching the other provided filters. For example, `filter[id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch the resource with id `798ac6d9-b3fc-4155-88ee-237f43f3404b`, while `filter[id]=798ac6d9-b3fc-4155-88ee-237f43f3404b,d79e513e-9246-454e-80bf-8268bc39cd6e,f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed` will fetch each of the resources with the ids `798ac6d9-b3fc-4155-88ee-237f43f3404b`, `d79e513e-9246-454e-80bf-8268bc39cd6e`, or `f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed`.
'
items:
type: string
format: uuid
is_nested:
type: boolean
description: 'Boolean true returns nested views, while boolean false returns top-level views. Omission will return all views.
Note: while the plan->block re-architecture work is ongoing, this filter option will also consider views with a root-level parent block *not* to be nested. This maintains expected compatibility with newly-created views. This filter option may be deprecated in the future.
'
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:
- blocks
- blocks.child_view
- blocks.block_connectors
- categories
- categories.blocks
- categories.blocks.block_connectors
- categories.blocks.child_view
- categories.blocks.child_view.categories
- categories.blocks.child_view.categories.blocks
- categories.category_type
- categories.charts
- categories.view
- category_type
- colors
- key_dates
style: form
explode: false
- 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
- name: expose
in: query
required: false
description: "Optionally calculated view metadata which are not part of responses by default.\n\nYou request that metadata be included in responses with the `expose` query\nparameter like: `?expose[view][meta]` or more granularly \n`?expose[view][meta][effective_privacy]`.\n"
style: deepObject
explode: true
schema:
type: object
additionalProperties: false
properties:
view:
type: object
additionalProperties: false
properties:
meta:
type:
- string
- 'null'
description: 'Exposing the metadata on each view resource populates the `meta` key with calculated attributes. If metadata is not exposed, the `meta` key will be an empty object. Detailed documentation on each metadata attribute is available in the response schema documentation.
'
responses:
'200':
description: A collection of Views.
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
title: view
type: object
required:
- id
- type
- attributes
- relationships
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- view
meta:
type:
- object
- 'null'
description: 'Optionally calculated view metadata which are not part of responses by default.
'
additionalProperties: false
properties:
effective_privacy:
type: string
enum:
- whole_workspace
- some_but_not_all
description: 'The effective privacy of a resource is calculated based on all direct and
inherited access. If a resource or any of its parents that it inherits
access from are accessible to the entire workspace, the effective privacy
is `whole_workspace`. Otherwise, the effective privacy is
`some_but_not_all`.
'
attributes:
type: object
required:
- title
- kind
- start_at
- end_at
- description
- default_timescale
- created_at
- updated_at
- start_month_index
- start_weekday_index
- show_smart_swimlane_datasource
- swimlane_title_column_width
additionalProperties: false
properties:
title:
type: string
description: A descriptive name for the view.
description:
type:
- string
- 'null'
description: A field allowing for additional descriptive text.
kind:
type: string
description: An enumeration representing the view type. Currently only supports Plan views.
enum:
- plan
default_timescale:
type: string
description: An enumeration representing the timescale of this view.
enum:
- day
- week
- month
- quarter
start_at:
type: string
description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value.
end_at:
type: string
description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the end of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value.
created_at:
type: string
format: date-time
description: An ISO 8601-formatted datetime indicating when the resource was created.
readOnly: true
updated_at:
type: string
format: date-time
description: An ISO 8601-formatted datetime indicating when the resource was last updated.
readOnly: true
start_month_index:
type: number
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February.
start_weekday_index:
type: number
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday.
show_smart_swimlane_datasource:
type: boolean
description: Whether to display the datasource filter information on smart swimlanes. Defaults to true.
swimlane_title_column_width:
type: integer
description: The width in pixels of the swimlane title column from 200 to 800 for persistence across sessions. Defaults to 200.
relationships:
type: object
additionalProperties: false
required:
- categories
- blocks
- owner
- creator
- workspace
- colors
- key_dates
- parent_block
properties:
categories:
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:
- category
category_type:
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:
- category_type
blocks:
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:
- block
owner:
title: User
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- user
creator:
title: User
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- user
workspace:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- workspace
colors:
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:
- view_color
key_dates:
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:
- key_date
parent_block:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- block
included:
type: array
items:
oneOf:
- title: block
type: object
required:
- id
- type
- attributes
- relationships
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- block
meta:
type:
- object
- 'null'
description: 'Optionally calculated block metadata which are not part of responses by default.
'
additionalProperties: false
properties:
effective_category_type:
type:
- object
- 'null'
description: The Block resou
# --- truncated at 32 KB (470 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-views-api-openapi.yml