API ReferenceProviders

Retrieve a provider

Retrieves a provider object by its ID.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

provider_idstringRequiredformat: "pr_.+"

Headers

X-Platform-IdstringOptional

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
idstringformat: "pr_.+"

Unique identifier for the provider. Prefixed with pr_.

namestring
The name of the provider.
descriptionstring
Description of the provider.
website_urlstring
The provider's main website URL.
logo_urlstring
URL to the provider's logo image.
support_phonestring
Customer support phone number.
supported_countrieslist of enums
List of countries supported by this provider.
objectstringOptionalRead-only

Object type. Always provider.

employer_platform_urlstring or nullOptional

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

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

Errors

404
Not Found Error