> 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 locations

GET https://api.confirm.global/partner/v1/locations

Returns the locations visible to your key. Pass `organization_ref` to scope the list to a single registry. Each location carries its `pay` (or `null`) and its standing `warnings`, including the no-pay warning for a location with no pay rate.


Reference: https://docs.confirm.global/partner-api/locations/list-locations

## Authentication

- `Authorization` header (bearer token, required) — Partner API key sent as `Authorization: Bearer cfk_...`. Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

## Request

### Query parameters

- `organization_ref` (string, optional) — Limit results to one registry.

## Response

### 200

Locations.

- `data` (list of PartnerLocation, optional)

## Errors

### 401 Unauthorized Error

Missing, malformed, or revoked API key (`error.type: authentication_error`).

- `error` (ErrorError, required)

### 404 Not Found Error

Unknown `organization_ref`.

- `error` (ErrorError, required)

### 429 Too Many Requests Error

Rate limit exceeded (`error.type: rate_limit_error`). Design target: 600 requests/min per key, burst 100/10s. Honor the `Retry-After` header.

- `error` (ErrorError, required)

## Types

### PartnerLocation

A registry location, backed by one screening-ready job.

- `location_id` (string, required) — CONFIRM's identifier for the location's job.
- `external_ref` (string, required) — Your location identifier, echoed back. Pass it as `location_ref` when ingesting applicants.
- `title` (string, required)
- `status` (enum, required)
  - Allowed values: `active`, `closed`
- `organization_ref` (string, optional) — The registry this location belongs to.
- `geocoded` (boolean, optional) — True when the location has coordinates. False means distance screening is inactive for this location — check `warnings`. An address without a street geocodes to the centre of the city or ZIP; `warnings` says so when that happens.
- `address` (string, optional, nullable) — The stored single-line address.
- `created` (boolean, optional) — False when the location already existed and this call was a no-op.
- `pay` (LocationPay, optional, nullable) — The location's pay rate, or `null` when it has none. With `null`, `warnings` includes "No pay rate set — the pay question will be skipped on screening calls for this location."
- `warnings` (list of string, optional)

### ErrorError

- `type` (enum, required) — Broad error category.
  - Allowed values: `authentication_error`, `invalid_request_error`, `not_found_error`, `conflict_error`, `rate_limit_error`, `api_error`
- `code` (string, required) — Machine-readable error code, e.g. `invalid_request`, `unknown_location_ref` or `wrong_environment`. Branch on this; the strings are contract.
- `message` (string, required) — Human-readable explanation.
- `request_id` (string, required) — Identifier for this request — the same value as the response's `X-Request-Id` header. Include it when contacting CONFIRM support.
- `details` (list of ErrorErrorDetailsItems, optional) — Present on `invalid_request` (400): one entry per field that failed validation.
- `location_ref` (string, optional) — Present on `unknown_location_ref` (404) — the reference that wasn't found.
- `organization_ref` (string, optional) — Present on `unknown_organization_ref` (404) — the reference that wasn't found — and on `email_has_account` (409) — the registry the invitation was for.
- `external_ref` (string, optional) — Present on workspace-teardown refusals (403) — the workspace you asked to delete — and on applicant errors (`unknown_candidate_ref`, `no_application_at_location`, `outcome_conflict`) — the applicant ref.
- `organization_refs` (list of string, optional) — Present on `ambiguous_location_ref` (409) — the registries the ref exists in.
- `locations` (list of ErrorErrorLocationsItems, optional) — Present on `location_refs_span_organizations` (400) — each ref you sent with the registry it belongs to.

### LocationPay

A location's stored pay rate. Every key is present; values that weren't set are `null`. `period` is `null` unless `min` or `max` is set.

- `min` (double, optional, nullable)
- `max` (double, optional, nullable)
- `period` (enum, optional, nullable)
  - Allowed values: `hourly`, `yearly`
- `text` (string, optional, nullable)

### ErrorErrorDetailsItems

- `field` (string, required) — Dotted path to the offending field, e.g. `address.postal_code`.
- `message` (string, required) — Why that field was rejected.

### ErrorErrorLocationsItems

- `location_ref` (string, optional)
- `organization_ref` (string, optional, nullable)

## Examples

**Response**

```json
{
  "data": [
    {
      "location_id": "string",
      "external_ref": "cl_loc_88213",
      "title": "Certified Nursing Assistant — Clearwater",
      "status": "active",
      "organization_ref": "cl_biz_4471",
      "geocoded": true,
      "address": "string",
      "created": true,
      "pay": {
        "min": 17,
        "max": 21,
        "period": "hourly",
        "text": null
      },
      "warnings": [
        "string"
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.confirm.global/partner/v1/locations"

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

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

print(response.json())
```

```javascript
const url = 'https://api.confirm.global/partner/v1/locations';
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/partner/v1/locations"

	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/partner/v1/locations")

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/partner/v1/locations")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.confirm.global/partner/v1/locations");
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/partner/v1/locations")! 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()
```