Retrieve Provider
GET /api/v1/providers/{slug}/
Retrieve details for a specific provider by its slug, including all format variants.
Authentication
No authentication required. This is a public endpoint.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
slug | string | The URL-friendly identifier of the provider (e.g. adp, gusto, paylocity). |
Response
Status: 200 OK
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "ADP",
"slug": "adp",
"description": "ADP payroll provider integration",
"supported_formats": ["payroll_journal", "tax_report", "benefits_summary"],
"format_variants": [
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "ADP Payroll Journal v2",
"format_type": "payroll_journal",
"version": "2.0"
}
]
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique identifier for the provider. |
name | string | Display name of the provider. |
slug | string | URL-friendly identifier. |
description | string | Brief description of the provider. |
supported_formats | array of strings | List of document format types this provider supports. |
format_variants | array | List of format variant objects for this provider. |
Format Variant Object
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique identifier for the format variant. |
name | string | Display name of the format variant. |
format_type | string | The type of document format. |
version | string | Version identifier for this format variant. |
Errors
| Status | Description |
|---|---|
404 | Provider not found. |
Code Examples
curl https://api.parsifyhq.com/api/v1/providers/adp/