Skip to main content

​
API Introduction

The Capital Check In API provides comprehensive endpoints for managing employee check-ins, authentication, user management, and more.

​
Base URL

https://api.capitalcheckin.app/v1

​
Authentication

All API endpoints require authentication using OAuth2 access tokens. Include your access token in the Authorization header: 
Authorization: Bearer YOUR_ACCESS_TOKEN

​
Content Type

All requests should use application/json as the Content-Type header.

​
Response Format

All API responses are returned in JSON format with the following structure: 
{
  "data": {
    // Response data
  },
  "meta": {
    // Metadata about the response
  }
}

​
Available Endpoints

​
Authentication

  • GET /oauth/authorize - OAuth2 authorization
  • POST /oauth/token - OAuth2 token exchange

​
Users

  • GET /auth/user - Get user profile

​
Collaborators

  • POST /collaborators - Create collaborator
  • GET /collaborators - Get collaborators list
  • GET /collaborators/{id} - Get collaborator by ID
  • PUT /collaborators/{id} - Update collaborator
  • DELETE /collaborators/{id} - Delete collaborator
  • POST /collaborators/bulk - Add multiple collaborators
  • POST /collaborators/{id}/role - Assign role
  • POST /collaborators/{id}/documents - Upload document
  • GET /collaborators/{id}/documents - Get collaborator documents
  • PUT /collaborators/{id}/photo - Update profile photo
  • GET /collaborators/{id}/status - Get collaborator status
  • GET /collaborators/{id}/history - Get collaborator history
  • GET /collaborators/{id}/notifications - Get notification preferences
  • PUT /collaborators/{id}/notifications - Update notification preferences
  • POST /collaborators/{id}/resend-invitation - Resend invitation
  • GET /collaborators/import-template - Download import template
  • POST /collaborators/import - Upload import template
  • GET /collaborators/export/individual - Export by collaborator
  • GET /collaborators/export/group - Export by group
  • GET /collaborators/export/list - Export by list

​
Rate Limiting

The API implements rate limiting to ensure fair usage. See the Rate Limiting documentation for details.

​
Error Handling

All errors follow a consistent format. See the Errors documentation for details.