> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Roosted HR API documentation — programmatic access to workforce scheduling for on-demand teams

## Welcome to the Roosted API

The Roosted API gives you programmatic access to the Roosted workforce scheduling platform. Manage events, shifts, workers, clients, time tracking, and more — directly from your own systems.

New to Roosted? Check out the [Getting Started guide](/guides/getting-started/getting-started-with-roosted) to learn the basics before diving into the API.

<Card title="API reference" icon="rocket" href="/api-reference/getting-started" horizontal>
  Get started with authentication, base URLs, and your first API call.
</Card>

## Core resources

<Columns cols={2}>
  <Card title="Workers" icon="users" href="/api-reference/v01.12.00/workers/get-workers">
    Create and manage your workforce — profiles, credentials, availability, shifts, and time punches.
  </Card>

  <Card title="Events" icon="calendar" href="/api-reference/v01.12.00/events/get-events">
    Schedule events and shifts, assign admins, and check capacity.
  </Card>

  <Card title="Clients" icon="building" href="/api-reference/v01.12.00/clients/get-clients">
    Manage client accounts, contacts, documents, orders, and worker assignments.
  </Card>

  <Card title="Time tracking" icon="clock" href="/api-reference/v01.12.00/time-tracking/get-worker-time-tracking-summary">
    Track hours worked with time punch and summary endpoints.
  </Card>
</Columns>

## Configuration and setup

<Columns cols={2}>
  <Card title="Locations" icon="location-dot" href="/api-reference/v01.12.00/locations/get-locations">
    Manage work locations for your events and shifts.
  </Card>

  <Card title="Skillsets" icon="star" href="/api-reference/v01.12.00/skillsets/get-skillsets">
    Define and assign skillsets to match workers with the right roles.
  </Card>

  <Card title="Rate cards" icon="money-bill" href="/api-reference/v01.12.00/rate-cards/get-rate-cards">
    Configure pay rates for different roles and clients.
  </Card>

  <Card title="Payroll groups" icon="file-invoice-dollar" href="/api-reference/v01.12.00/payroll-groups/get-payroll-groups">
    Organize workers into payroll groups for streamlined processing.
  </Card>
</Columns>

## Need help?

Contact [support@roostedhr.com](mailto:support@roostedhr.com) to request API keys or get assistance with your integration.