Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Providers

Retrieve a provider

Retrieves a provider object by its ID.

get/providers/{provider_id}

Path parameters

provider_idstring required
Example:pr_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK

objectstring

Object type. Always provider.

idstring required

Unique identifier for the provider. Prefixed with pr_.

namestring required

The name of the provider.

descriptionstring required

Description of the provider.

website_urlstring required

The provider's main website URL.

logo_urlstring required

URL to the provider's logo image.

employer_platform_urlstring nullable

URL to the employer portal/platform for this provider, if available.

kota_hub_urlstring nullable

URL to the Kota Hub page for this platform, if configured.

support_phonestring required

Customer support phone number.

supported_countriesCountryCode[] required

List of countries supported by this provider.

Example response

{
  "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a"
}