A valid request URL is required to generate request examples{
"pipelines": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"step_count": 1,
"links": {
"self": "<string>",
"ui": "<string>"
},
"destination": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
}
}
],
"jobs": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"type": "<string>",
"links": {
"self": "<string>",
"ui": "<string>"
},
"source_connection": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
},
"destination_connection": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
}
}
],
"transformations": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"type": "<string>",
"links": {
"self": "<string>",
"ui": "<string>"
},
"destination_connection": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
}
}
],
"events": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"pipeline_id": "<string>",
"pipeline": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
},
"links": {
"self": "<string>",
"ui": "<string>"
}
}
],
"connections": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"connector": "<string>",
"links": {
"self": "<string>",
"ui": "<string>"
}
}
]
}{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}Search resources
Searches accessible connections, pipelines, jobs, transformations, and named pipeline events across one or more workspaces. Results are ordered by resource type (Pipeline, Job, Transformation, Event, Connection), then by name, workspace ID, and resource ID before global paging is applied. By default, only the first 20 matching resources are returned across all types combined, not 20 per type. Each array contains only the resources on the selected page; an empty array does not mean that no matching resources of that type exist. X-Total-Count reports the total number of matching resources before paging. Use skip=20&top=20 for the second page, or resource_type=connection,transformation to restrict the search to those types before paging.
A valid request URL is required to generate request examples{
"pipelines": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"step_count": 1,
"links": {
"self": "<string>",
"ui": "<string>"
},
"destination": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
}
}
],
"jobs": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"type": "<string>",
"links": {
"self": "<string>",
"ui": "<string>"
},
"source_connection": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
},
"destination_connection": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
}
}
],
"transformations": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"type": "<string>",
"links": {
"self": "<string>",
"ui": "<string>"
},
"destination_connection": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
}
}
],
"events": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"pipeline_id": "<string>",
"pipeline": {
"id": "<string>",
"name": "<string>",
"connector": "<string>",
"error": "<string>"
},
"links": {
"self": "<string>",
"ui": "<string>"
}
}
],
"connections": [
{
"id": "<string>",
"name": "<string>",
"workspace_id": "<string>",
"connector": "<string>",
"links": {
"self": "<string>",
"ui": "<string>"
}
}
]
}{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}Authorizations
A Sync user auth token. Generate one via POST /v2/users/generate-token.
Query Parameters
Exact resource name. When name and $filter are both supplied, both conditions must match.
Comma-separated resource types. Supported values are connection, pipeline, job, transformation, and event.
Comma-separated workspace identifiers. When omitted, all accessible workspaces are searched. Unknown or inaccessible identifiers do not produce results.
OData-style filter expression applied to the collection, on endpoints that support filtering (e.g. name eq 'my_job'). Filters on resource fields such as id and name. Substring matching with contains(name,'my_job') is case-insensitive. startswith and endswith retain their existing behavior; case sensitivity depends on the AppDB collation.
Maximum number of matching resources to return across all selected resource types combined, not per type. Defaults to 20.
x >= 0Number of records to skip before returning results (pagination), where supported.
Response
Matching resources on the selected global page.
Resources on the selected global page, grouped by type. All five arrays are always present. An array can be empty even when matching resources of that type exist on another page.