Skip to main content
GET
Get resources

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

The pagination cursor value.

page_size
integer

Number of results to return per page. Default is 200.

Required range: x <= 1000
resource_type_filter
enum<string>

The resource type to filter by. Required when remote_id is provided. The type of the resource.

Available options:
AWS_IAM_ROLE,
AWS_EC2_INSTANCE,
AWS_EKS_CLUSTER,
AWS_RDS_POSTGRES_CLUSTER,
AWS_RDS_POSTGRES_INSTANCE,
AWS_RDS_MYSQL_CLUSTER,
AWS_RDS_MYSQL_INSTANCE,
AWS_ACCOUNT,
AWS_SSO_PERMISSION_SET,
AWS_ORGANIZATIONAL_UNIT,
AWS_AGENTCORE_GATEWAY,
AWS_AGENTCORE_GATEWAY_TARGET,
AWS_AGENTCORE_GATEWAY_TOOL,
MCP_SERVER,
MCP_TOOL,
AZURE_MANAGEMENT_GROUP,
AZURE_RESOURCE_GROUP,
AZURE_SUBSCRIPTION,
AZURE_VIRTUAL_MACHINE,
AZURE_STORAGE_ACCOUNT,
AZURE_STORAGE_CONTAINER,
AZURE_SQL_SERVER,
AZURE_SQL_MANAGED_INSTANCE,
AZURE_SQL_DATABASE,
AZURE_SQL_MANAGED_DATABASE,
AZURE_USER_ASSIGNED_MANAGED_Identity,
AZURE_ENTRA_ID_ROLE,
AZURE_ENTERPRISE_APP,
CUSTOM,
CUSTOM_CONNECTOR,
DATABRICKS_ACCOUNT_SERVICE_PRINCIPAL,
GCP_ORGANIZATION,
GCP_BUCKET,
GCP_COMPUTE_INSTANCE,
GCP_FOLDER,
GCP_GKE_CLUSTER,
GCP_PROJECT,
GCP_CLOUD_SQL_POSTGRES_INSTANCE,
GCP_CLOUD_SQL_MYSQL_INSTANCE,
GCP_BIG_QUERY_DATASET,
GCP_BIG_QUERY_TABLE,
GCP_SERVICE_ACCOUNT,
GCP_BILLING_ACCOUNT,
GIT_HUB_REPO,
GIT_HUB_ORG_ROLE,
GIT_LAB_PROJECT,
GOOGLE_WORKSPACE_ROLE,
MONGO_INSTANCE,
MONGO_ATLAS_INSTANCE,
NETSUITE_ROLE,
DATADOG_ROLE,
OKTA_APP,
OKTA_ROLE,
OKTA_WORKLOAD_PRINCIPAL,
OPAL_ROLE,
OPAL_SCOPED_ROLE,
PAGERDUTY_ROLE,
TAILSCALE_SSH,
SALESFORCE_PERMISSION_SET,
SALESFORCE_PROFILE,
SALESFORCE_ROLE,
SNOWFLAKE_DATABASE,
SNOWFLAKE_SCHEMA,
SNOWFLAKE_TABLE,
WORKDAY_ROLE,
MYSQL_INSTANCE,
MARIADB_INSTANCE,
POSTGRES_INSTANCE,
TELEPORT_ROLE,
ILEVEL_ADVANCED_ROLE,
DATASTAX_ASTRA_ROLE,
COUPA_ROLE,
CURSOR_ORGANIZATION,
CURSOR_ORIGIN_REPOSITORY,
CURSOR_USER,
CURSOR_BOT,
OPENAI_PLATFORM_PROJECT,
OPENAI_PLATFORM_SERVICE_ACCOUNT,
OPENAI_USER,
ANTHROPIC_WORKSPACE,
ANTHROPIC_USER,
ANTHROPIC_SERVICE_ACCOUNT,
GIT_HUB_ORG,
ORACLE_FUSION_ROLE,
DEVIN_ORGANIZATION,
DEVIN_ROLE,
VAULT_SECRET,
VAULT_POLICY,
VAULT_OIDC_ROLE,
GIT_HUB_ENTERPRISE_ROLE,
GRAFANA_FOLDER,
GRAFANA_DASHBOARD,
GRAFANA_BASIC_ROLE,
GRAFANA_ROLE,
CLICKHOUSE_DATABASE,
CLICKHOUSE_TABLE,
CLICKHOUSE_CONSOLE_ROLE,
TWINGATE_RESOURCE,
ZENDESK_ROLE,
HUBSPOT_ROLE,
ALICLOUD_RAM_ROLE,
ALICLOUD_ECS_INSTANCE,
DOCUSIGN_PERMISSION_PROFILE,
ZOOM_ROLE,
ZOOM_LICENSE,
LINEAR_ORGANIZATION,
LINEAR_PROJECT,
RAMP_FUND,
RAMP_ROLE,
WRIKE_USER_TYPE,
DATABRICKS_CATALOG,
DATABRICKS_SCHEMA,
DATABRICKS_VOLUME,
DATABRICKS_FUNCTION,
DATABRICKS_MODEL,
DATABRICKS_SERVICE,
DATABRICKS_MCP_SERVER,
VERCEL_ROLE,
VERCEL_PROJECT,
AXIOM_ROLE,
AXIOM_CUSTOM_ROLE,
RIPPLING_DEPARTMENT,
BOX_ENTERPRISE,
BOX_FOLDER,
SLACK_WORKSPACE,
SLACK_ORGANIZATION,
ASANA_WORKSPACE,
ASANA_WORKSPACE_GUEST,
BITWARDEN_ORGANIZATION,
CALENDLY_ROLE,
CALENDLY_EVENT_TYPE,
MIRO_ORGANIZATION,
MIRO_BOARD,
ONELOGIN_APP,
SUPABASE_ORGANIZATION,
SUPABASE_PROJECT,
SUPABASE_PROJECT_AUTH,
TRAY_WORKSPACE,
TRAY_ORGANIZATION
Example:

"AWS_IAM_ROLE"

resource_ids
string<uuid>[]

The resource ids to filter by.

resource_name
string

Filter resources by name. Matches against name, remote_name, parent-name combinations, and remote_id. Matching is case-insensitive. Use resource_name_match to choose the match type; when omitted, CONTAINS (substring) is used.

resource_name_match
enum<string>

How to apply resource_name. Requires resource_name to be set. Defaults to CONTAINS when resource_name is provided without this parameter. EQUALS, STARTS_WITH, and ENDS_WITH match only the resource's own name and remote_name, not parent-name combinations or remote_id. How to match a free-text name filter on list endpoints. All match types are case-insensitive. When omitted, CONTAINS is used. REGEX is not supported here — use POST /queries/run for regular-expression matching.

Available options:
CONTAINS,
EQUALS,
STARTS_WITH,
ENDS_WITH
parent_resource_id
string<uuid>

The parent resource id to filter by.

ancestor_resource_id
string<uuid>

The ancestor resource id to filter by. Returns all resources that are descendants of the specified resource.

remote_id
string

Filter resources by their remote id. This will return all resources that have a remote id that matches the provided remote id. Note that this requires resource_type_filter to be provided.

tag_ids
string<uuid>[]

The IDs of the tags to filter by. Returns only resources that have any of these tags applied.

app_id
string<uuid>

Only return resources that belong to this app.

requestable_by_user_id
string<uuid>

Only return resources this user can request at one or more access levels, using the same evaluation as GET /resources/{resource_id}/requestable/users/{user_id}. Filtering for another user requires an Opal admin or a custom role with the CHECK_REQUESTABILITY permission. The response is always filtered by the caller's own READ visibility, so a non-admin CHECK_REQUESTABILITY holder sees the intersection of items they can read and items the target user can request. Filtering for yourself needs no permission.

Response

One page worth resources associated with your organization.

results
object[]
required
next
string | null

The cursor with which to continue pagination if additional result pages exist.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

previous
string | null

The cursor used to obtain the current result page.

Example:

"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ"