Schedule Management

Get WhatsApp Business Account Schedules

Retrieve all schedules associated with a WhatsApp Business Account, including their configuration, status, and execution details.

Use Cases:

  • List all schedules in a WhatsApp Business Account
  • Monitor schedule status and performance
  • Check schedule configuration and timing details
  • Retrieve schedule execution history and metrics

Filtering: You can filter results using the filtering parameter with JSON-encoded filter conditions. Supported filters include status, schedule_type, and is_active.

Sorting: Results can be sorted by created_time or updated_time in ascending or descending order.

Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.

Caching: Schedule data can be cached for short periods, but status information may change frequently. Implement appropriate cache invalidation strategies.

get/{Version}/{WABA-ID}/schedules

Request

  • Base URL
    https://graph.facebook.com
  • URL
    https://graph.facebook.com/{Version}/{WABA-ID}/schedules
  • Auth
    HTTP bearer

Path parameters

Versionstring required

Graph API version to use for this request. Determines the API behavior and available features.

WABA-IDstring required

WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager or through the business management APIs.

Query parameters

fieldsstring

Comma-separated list of fields to include in the response. If not specified, default fields will be returned. Available fields include: id, name, status, schedule_type, description, start_time, end_time, timezone, days_of_week, created_time, updated_time, is_active, recurrence_pattern

filteringstring

JSON-encoded array of filter conditions. Each filter should specify field, operator, and value. Supported fields: status, schedule_type, is_active

sort'created_time.asc' | 'created_time.desc' | 'updated_time.asc' | 'updated_time.desc'

Sort field and direction. Format: field_name.asc or field_name.desc Supported fields: created_time, updated_time

limitinteger

Maximum number of schedules to return per page

afterstring

Cursor for pagination - retrieve records after this cursor

beforestring

Cursor for pagination - retrieve records before this cursor

Headers

User-Agentstring
Example:Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21

The user agent string identifying the client software making the request.

Authorizationstring required
Example:Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...

Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

Response

Successfully retrieved WhatsApp Business Account schedules

Example response

{
  "data": [
    {
      "id": "1234567890123456",
      "name": "Daily Business Hours Schedule",
      "status": "ACTIVE",
      "schedule_type": "BUSINESS_HOURS",
      "description": "Automated responses during business hours",
      "start_time": "09:00",
      "end_time": "17:00",
      "timezone": "America/New_York",
      "days_of_week": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY"
      ],
      "created_time": "2024-01-15T10:30:00Z",
      "updated_time": "2024-01-20T14:45:00Z",
      "is_active": true,
      "recurrence_pattern": {
        "frequency": "WEEKLY",
        "interval": 1,
        "end_date": "2024-12-31"
      }
    }
  ],
  "paging": {
    "cursors": {
      "before": "QVFIUjNpUWpVWmRBd0dn",
      "after": "QVFIUjNpUWpVWmRBd0Rn"
    },
    "previous": "https://graph.facebook.com/v23.0/1234567890/connected_client_businesses?before=QVFIUjNpUWpVWmRBd0Dn",
    "next": "https://graph.facebook.com/v23.0/1234567890/connected_client_businesses?after=QVFIUjNpUWpVWmRBd0Rn"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.