---
title: "Get credential guidance for a provider"
method: GET
path: "/v1/connectors/catalog/{domain}/guidance"
tags: ["Connectors"]
---

# Get credential guidance for a provider

`GET /v1/connectors/catalog/{domain}/guidance`

## Request

- Base URL: `https://api.spacefast.com`
- URL: `https://api.spacefast.com/v1/connectors/catalog/{domain}/guidance`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.spacefast.com/v1/auth/oauth2/authorize`, token URL `https://api.spacefast.com/v1/auth/oauth2/token`; client credentials, token URL `https://api.spacefast.com/v1/auth/oauth2/token`, scopes: `connectors:read`)

What the provider calls its key, where to mint it, and any setup notes — rendered inline next to the field asking for it. Served from the registry cache; empty when the registry knows nothing.

## Path parameters

- `domain` string, required: Provider domain the logo belongs to, e.g. `stripe.com`.

## Query parameters

- `team` string: Team id or slug to act for. Required only when the credential could act for more than one team.

## Response `200`

Per-provider credential guidance for the connect modal; empty when the registry knows none.

- object: Per-provider credential guidance for the connect modal; empty when the registry knows none.
  - `$schema` string, uri: Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.
  - `data` object[], required
    - `label` string, nullable, required: The provider’s display label for this credential.
    - `mintUrl` string, nullable, required: Page on the provider where the credential is created.
    - `docsUrl` string, nullable, required: Provider documentation for this credential.
    - `notes` string, nullable, required: Setup notes: prerequisites, plan requirements, scopes to tick.
    - `steps` string[], required: Ordered steps to get the credential, when the provider spells them out.

## Other responses

- `default`: Problem details (RFC 9457). Any 4xx/5xx response is one `application/problem+json` document.

---

[API](https://skmtc.dev/spacefast/apis/spacefast-api.md) · [All operations](https://skmtc.dev/spacefast/apis/spacefast-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spacefast/apis/spacefast-api/revisions/bd165bc7c983?raw)