Get one of the Account's payroll schedules

get

https://api.wingspan.app/v3/payments/payroll-schedules/{type}

Retrieve the effective Account's schedule for type. At most one schedule exists per type, so type alone addresses the resource; 404 when the underlying settings document has no cadence configured.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type

string

enum

required

Which of the Account's two schedules to address. There is no separate schedule identifier to mint, so this plus the effective Account names the resource.

Allowed:

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Payroll schedule detail

401Unauthenticated

403Forbidden

404Resource not found