Skip to main content
GET
cURL
Learn more about Payroll Platforms in the Glossary.

Authorizations

Authorization
string
header
required

Bearer token obtained from the /v1/auth/token endpoint. Send as: Authorization: Bearer .

Path Parameters

payroll_platform
string
required

Response

Successfully retrieved payroll platform

id
string<uuid>
required

A unique string identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
displayName
string
required

A human-readable name for the entity

supports
object
required

A map of features supported by this payroll platform

onboarding
object
required