> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.confirm.global/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.confirm.global/_mcp/server.

# List background check pipelines

GET https://api.confirm.global/api/v1/background-checks/pipelines

Returns active background check pipeline templates (global plus your organization's), including their ordered steps and services.


Reference: https://docs.confirm.global/api-reference/background-checks/list-background-check-pipelines

## Authentication

- `Authorization` header (bearer token, required) — Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

## Request

### Query parameters

- `org_id` (string, optional) — Include this organization's templates alongside global ones.

## Response

### 200

Pipeline templates.

- `success` (boolean, optional)
- `data` (list of BackgroundCheckPipeline, optional)

## Errors

### 400 Bad Request Error

The request was invalid (missing or malformed fields, or an invalid stage transition).

- `error` (ErrorError, optional)

### 401 Unauthorized Error

Missing or invalid bearer token, or insufficient permissions.

- `error` (ErrorError, optional)

## Types

### BackgroundCheckPipeline

- `id` (string, optional)
- `org_id` (string, optional, nullable) — Null for global templates.
- `name` (string, optional)
- `description` (string, optional, nullable)
- `execution_mode` (string, optional) — e.g. waterfall.
- `is_active` (boolean, optional)
- `enrichment_pipeline_steps` (list of BackgroundCheckPipelineEnrichmentPipelineStepsItems, optional)

### ErrorError

- `code` (string, optional) — Machine-readable error code, e.g. VALIDATION_ERROR or CANDIDATE_NOT_FOUND.
- `message` (string, optional)
- `request_id` (string, optional) — Identifier for this request, useful when contacting support.

### BackgroundCheckPipelineEnrichmentPipelineStepsItems

- `service_id` (string, optional)
- `step_order` (integer, optional)
- `condition_type` (string, optional)
- `is_required` (boolean, optional)
- `is_blocking` (boolean, optional)
- `service` (BackgroundCheckService, optional)

### BackgroundCheckService

- `id` (string, optional)
- `service_code` (string, optional)
- `service_name` (string, optional)
- `service_category` (string, optional)
- `cost_cents` (integer, optional)
- `is_instant` (boolean, optional)
- `vendor` (BackgroundCheckServiceVendor, optional)

### BackgroundCheckServiceVendor

- `vendor_code` (string, optional)
- `vendor_name` (string, optional)

## Examples

**Response**

```json
{
  "success": true,
  "data": [
    {
      "id": "string",
      "org_id": "string",
      "name": "string",
      "description": "string",
      "execution_mode": "string",
      "is_active": true,
      "enrichment_pipeline_steps": [
        {
          "service_id": "string",
          "step_order": 1,
          "condition_type": "string",
          "is_required": true,
          "is_blocking": true,
          "service": {
            "id": "string",
            "service_code": "string",
            "service_name": "string",
            "service_category": "string",
            "cost_cents": 1,
            "is_instant": true,
            "vendor": {
              "vendor_code": "string",
              "vendor_name": "string"
            }
          }
        }
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.confirm.global/api/v1/background-checks/pipelines"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.confirm.global/api/v1/background-checks/pipelines';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.confirm.global/api/v1/background-checks/pipelines"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.confirm.global/api/v1/background-checks/pipelines")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.confirm.global/api/v1/background-checks/pipelines")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.confirm.global/api/v1/background-checks/pipelines', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.confirm.global/api/v1/background-checks/pipelines");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.confirm.global/api/v1/background-checks/pipelines")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```