Mail API reference

Mail API · Integrations

get/v1/workspaces/{workspace_id}/integrations/{provider}Auth

Get a single integration detail with redacted credentials.

Includes the provider's `credentials_redacted` view. Secret fields (access tokens, signing keys) are never included.

Path parameters

workspace_id*string · uuid

Id of the workspace.

provider*string

The integration provider (`github`).

Response · 200

provider*string

Integration provider id.

Example: "github"

display_name*string

Display name of the provider.

Example: "GitHub"

account_login*string

Account login at the provider that was connected.

Example: "octocat"

account_avatar_url*string · uri

Avatar of the connected account; null when the provider has none.

Example: "https://avatars.githubusercontent.com/u/1?v=4"

status*object

Connection health: `active`, `error` (the last call failed) or `revoked` (access was withdrawn at the provider).

Example: "active"

last_error*string

Surfaced when status is 'error' — last failure message.

last_synced_at*string · date-time

When the last successful sync ran. null until first success.

settings*object

Provider-specific non-secret settings (e.g. selected repo / branch / path).

updated_at*string · date-time

When the connection was last changed.

credentials_redacted*object

Provider's redacted credential view — public identifiers + a 'token_present' boolean. Secrets NEVER round-trip.

Example

Request

GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/integrations/{provider}
Authorization: Bearer YOUR_TOKEN

Response

{
  "provider": "github",
  "display_name": "GitHub",
  "account_login": "octocat",
  "account_avatar_url": "https://avatars.githubusercontent.com/u/1?v=4",
  "status": "active",
  "last_error": "string",
  "last_synced_at": "2026-01-01T00:00:00.000Z",
  "settings": {},
  "updated_at": "2026-01-01T00:00:00.000Z",
  "credentials_redacted": {}
}