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

# Get an endpoint

GET https://api.usepassport.ai/public/v1/endpoints/{endpointId}

Fetch one endpoint. Link header points at secret-bindings.

Reference: https://docs.usepassport.ai/api-reference/endpoints/get-endpoint

## Authentication

- `Authorization` header (bearer token, required) — WorkOS API key (Authorization: Bearer sk_...). Scope comes from the key's permissions: a key carrying `passport:admin` has admin scope (full catalog CRUD), any other key has member scope (reads + access requests). Organization-owned keys are admin by ownership and carry no associated user; keys minted for a user carry theirs, which is what access requests and `createdBy` are attributed to.

## Request

### Path parameters

- `endpointId` (string, required)

## Response

### 200

OK

- `data` (Endpoint, required)

## Errors

### 401 Unauthorized Error

Missing or invalid API key. Unlike every other response, this one carries no `RateLimit-*` headers: the request is rejected before a key is resolved, so there is no per-key window to report. Rejection happens at the gateway, which renders this same schema (and negotiates `application/problem+json` identically).

- `error` (ErrorError, required)

### 404 Not Found Error

Resource endpoint not found.

- `error` (ErrorError, required)

### 429 Too Many Requests Error

Rate limit exceeded.

- `error` (ErrorError, required)

### 500 Internal Server Error

Unexpected server error.

- `error` (ErrorError, required)

### 503 Service Unavailable Error

Temporary unavailability (auth dependency down, encryption-config resolution failure, or discovery document unloadable).

- `error` (ErrorError, required)

## Types

### Endpoint

- `id` (string, optional)
- `namespaceId` (string, optional)
- `method` (enum, optional)
  - Allowed values: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`, `*`
- `host` (string, optional)
- `path` (string, optional)
- `status` (enum, optional) — 1 = enabled, 0 = disabled.
  - Allowed values: `0`, `1`
- `metadata` (map from string to any, optional, nullable) — Arbitrary JSON object, or null.
- `secrets` (list of SecretBinding, optional)
- `resourceGroupIds` (list of string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)

### ErrorError

- `code` (enum, required) — The machine-readable failure reason. Treat a value not listed here as a generic failure of the class implied by the HTTP status, and do not assume retry behaviour for it — new codes may be added.
  - Allowed values: `VALIDATION_ERROR`, `MALFORMED_JSON`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `UNPROCESSABLE_ENTITY`, `PAYLOAD_TOO_LARGE`, `RATE_LIMITED`, `INTERNAL_ERROR`, `SERVICE_UNAVAILABLE`
- `message` (string, required)
- `details` (list of FieldError, optional)

### SecretBinding

- `label` (string, required) — Display name of the slot, for example `Authorization`. It identifies the slot within its endpoint and has no effect on where a secret may be used, which is decided only by `allowedLocations`.
- `secretReferenceId` (string, optional, nullable) — null for an unmapped slot.
- `allowedLocations` (SecretBindingAllowedLocations, optional, nullable) — Where the secret reference may be substituted in a request, as a JSON object (never a string). `{"v": 1, "headers": ["x-api-key"]}` means the proxy substitutes it only in those request headers, never in the URI, query string or body. `null` means anywhere. Admin-set. `v` must be 1 and `headers` holds 1 to 16 header names; anything else returns `400`. Header names are trimmed, lower-cased, de-duplicated and sorted on write, so the response can differ from the request. Responses leave the field out when a slot has no rule. When a slot is saved without a rule, the recommended rule for a known LLM host (for example `api.anthropic.com` or `api.openai.com`) is filled in, so a response can contain a rule you did not send; send `null` to allow anywhere.

### FieldError

- `field` (string, optional)
- `message` (string, optional)

### SecretBindingAllowedLocations

Where the secret reference may be substituted in a request, as a JSON object (never a string). `{"v": 1, "headers": ["x-api-key"]}` means the proxy substitutes it only in those request headers, never in the URI, query string or body. `null` means anywhere. Admin-set. `v` must be 1 and `headers` holds 1 to 16 header names; anything else returns `400`. Header names are trimmed, lower-cased, de-duplicated and sorted on write, so the response can differ from the request. Responses leave the field out when a slot has no rule. When a slot is saved without a rule, the recommended rule for a known LLM host (for example `api.anthropic.com` or `api.openai.com`) is filled in, so a response can contain a rule you did not send; send `null` to allow anywhere.

- `v` (enum, required)
  - Allowed values: `1`
- `headers` (list of string, required)

## Examples

**Response**

```json
{
  "data": {
    "id": "c3d4e5f6-3333-4444-5555-666677778888",
    "namespaceId": "3f7c2b6e-1c2d-4a5b-9e8f-0a1b2c3d4e5f",
    "method": "GET",
    "host": "api.example.com",
    "path": "/v1/charges",
    "status": 1,
    "secrets": [],
    "resourceGroupIds": []
  }
}
```

**SDK Code**

```python default
import requests

url = "https://api.usepassport.ai/public/v1/endpoints/endpointId"

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

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

print(response.json())
```

```javascript default
const url = 'https://api.usepassport.ai/public/v1/endpoints/endpointId';
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 default
package main

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

func main() {

	url := "https://api.usepassport.ai/public/v1/endpoints/endpointId"

	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 default
require 'uri'
require 'net/http'

url = URI("https://api.usepassport.ai/public/v1/endpoints/endpointId")

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 default
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.usepassport.ai/public/v1/endpoints/endpointId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.usepassport.ai/public/v1/endpoints/endpointId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp default
using RestSharp;

var client = new RestClient("https://api.usepassport.ai/public/v1/endpoints/endpointId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift default
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.usepassport.ai/public/v1/endpoints/endpointId")! 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()
```