API Documentation

Getting Started

Overview

The Log My Business API allows third-party applications to access and manage organization data including customers, projects, tasks, time entries, and mileage records. All API endpoints are scoped to an organization and require proper authentication.

Base URL

https://app.logmybusiness.com/api

Organization ID

All API endpoints require your Organization ID in the path. You can find it in two places:

• The Developer Portal displays your Organization ID at the top of the page
• Authorization Code flow only: Call GET /api/organization/my-organizations with your access token to list all organizations the authenticated user belongs to

Quick Start

1. Go to the Developer Portal and register a new application
2. Choose Confidential for server-to-server access or Public for browser/mobile apps
3. Select the API scopes your application needs
4. Save your Client ID and Client Secret (shown only once)
5. Use the credentials to obtain an access token
6. Include the access token in the Authorization header of your API requests

Two Authentication Flows

Authentication

Client Credentials Flow

Exchange your client credentials for an access token. Requires a confidential client.

Request

POST /connect/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=YOUR_CLIENT_ID
&client_secret=YOUR_CLIENT_SECRET
&scope=api:customers:read api:projects:read

Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Authorization Code + PKCE Flow

For applications that need user-delegated access. Works with both public and confidential clients.

Step 1: Redirect user to authorize

GET /connect/authorize?
  client_id=YOUR_CLIENT_ID
  &response_type=code
  &redirect_uri=https://your-app.com/callback
  &scope=openid email profile api:customers:read
  &code_challenge=YOUR_PKCE_CHALLENGE
  &code_challenge_method=S256

The user will see a consent screen listing the requested permissions. After approving, they'll be redirected to your redirect_uri with an authorization code.

Step 2: Exchange code for token

POST /connect/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code
&client_id=YOUR_CLIENT_ID
&code=AUTHORIZATION_CODE
&redirect_uri=https://your-app.com/callback
&code_verifier=YOUR_PKCE_VERIFIER

Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "eyJhbGciOiJSUzI1NiIs...",
  "id_token": "eyJhbGciOiJSUzI1NiIs..."
}

Refreshing Tokens

POST /connect/token
Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token
&client_id=YOUR_CLIENT_ID
&refresh_token=YOUR_REFRESH_TOKEN

Using Access Tokens

Include the access token in the Authorization header of every API request:

GET /api/customer/{organizationId}
Authorization: Bearer YOUR_ACCESS_TOKEN

Scopes

API Scopes

Scopes control what data your application can access. Request only the scopes you need.

Endpoints

All endpoints require authentication and are scoped to an organization via the {organizationId} path parameter. Abbreviated as {orgId} below.

Organization Members

Response

[
  {
    "userId": "abc-123",
    "email": "user@example.com",
    "displayName": "Jane Smith",
    "firstName": "Jane",
    "lastName": "Smith",
    "role": "Admin",
    "joinedAt": "2025-06-15T10:30:00Z"
  }
]

Customers

Create / Update Request Body

{
  "name": "Acme Corp",              // required
  "companyName": "Acme Corporation",
  "email": "contact@acme.com",
  "phoneNumber": "555-0100",
  "addressLine1": "123 Main St",
  "city": "Springfield",
  "stateProvince": "IL",
  "postalCode": "62704",
  "country": "US",
  "customerType": "Business",
  "status": "Active",
  "notes": "Key account",
  "creditLimit": 10000.00
}

Projects

Create / Update Request Body

{
  "name": "Website Redesign",       // required
  "customerId": 1,                   // optional, link to customer
  "description": "Full site overhaul",
  "status": "Active",
  "projectCode": "WEB-001",
  "hourlyRate": 150.00,
  "isBillable": true,
  "startDate": "2025-01-15",
  "endDate": "2025-06-30",
  "budgetAmount": 50000.00
}

Tasks

Create Request Body

{
  "title": "Design homepage mockup",  // required
  "projectId": 1,                      // required
  "description": "Create initial wireframes",
  "priority": 2,                        // 0=Low, 1=Medium, 2=High, 3=Critical
  "dueDate": "2025-02-28",
  "startDate": "2025-02-01",
  "estimatedHours": 8.0,
  "assigneeIds": ["user-id-1", "user-id-2"],
  "tagIds": [1, 3]
}

Update Request Body (all fields optional)

{
  "title": "Updated title",
  "status": "InProgress",             // Todo, InProgress, Review, Done
  "priority": 3,                        // 0=Low, 1=Medium, 2=High, 3=Critical
  "progress": 50,
  "actualHours": 4.5
}

Comment Request Body (POST / PUT)

{
  "comment": "Looks good — ready for review"  // required, max 5000 chars
}

Comment Response

{
  "id": 42,
  "taskId": 5,
  "userId": "abc-123",
  "userName": "Jane Smith",
  "profilePictureUrl": null,
  "comment": "Looks good — ready for review",
  "createdAt": "2026-05-05T14:22:00Z",
  "updatedAt": null,
  "isSystemGenerated": false
}

Tags

Create / Update Request Body

{
  "name": "Urgent",                   // required
  "color": "#EF4444",                 // required, hex color
  "description": "High priority items"
}

Time Entries

Create / Update Request Body

{
  "projectId": 1,                      // required
  "date": "2025-02-15",               // required
  "hours": 4.5,                        // required, 0.01-24
  "categoryId": 2,                     // optional project category
  "taskId": 5,                         // optional link to task
  "description": "Frontend work",
  "startTime": "09:00:00",            // optional
  "endTime": "13:30:00"               // optional
}

Mileage

Create Request Body

{
  "projectId": 1,                      // required
  "date": "2025-02-15",               // required
  "totalMiles": 45.2,                 // required
  "startMiles": 12500.0,              // optional, odometer start
  "endMiles": 12545.2,                // optional, odometer end
  "mileageRate": 0.67,                // optional, override default
  "description": "Client site visit",
  "isBillable": true
}

Errors

Error Handling

The API uses standard HTTP status codes to indicate success or failure.

Error Response Format

{
  "message": "A human-readable error description"
}

HTTP Status Codes