> For a complete page index, fetch https://developer.close.com/llms.txt

# List or filter all WhatsAppMessage activities

GET https://api.close.com/api/v1/activity/whatsapp_message/

Filter by `external_whatsapp_message_id` to find messages to update or delete based on changes in WhatsApp.

Reference: https://developer.close.com/api/resources/activities/whatsapp/list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Close API
  version: 1.0.0
paths:
  /activity/whatsapp_message/:
    get:
      operationId: list
      summary: List or filter all WhatsAppMessage activities
      description: >-
        Filter by `external_whatsapp_message_id` to find messages to update or
        delete based on changes in WhatsApp.
      tags:
        - subpackage_activitiesWhatsappMessages
      parameters:
        - name: _limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: integer
            default: 100
        - name: _skip
          in: query
          description: Number of results to skip before returning, for pagination.
          required: false
          schema:
            type: integer
            default: 0
        - name: id__in
          in: query
          description: Filter by activity IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: lead_id
          in: query
          description: Filter by lead IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: contact_id
          in: query
          description: Filter by contact IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: user_id
          in: query
          description: Filter by user IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: organization_id
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: _type
          in: query
          description: Filter by activity type, e.g. Call (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: date_created__gte
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedGte
        - name: date_created__lte
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedLte
        - name: date_created__gt
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedGt
        - name: date_created__lt
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedLt
        - name: activity_at__gte
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersActivityAtGte
        - name: activity_at__lte
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersActivityAtLte
        - name: activity_at__gt
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersActivityAtGt
        - name: activity_at__lt
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/ActivityWhatsappMessageGetParametersActivityAtLt
        - name: external_whatsapp_message_id
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: Authorization
          in: header
          description: Use your API key as the username and leave the password empty.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/activities.whatsapp_messages_list_Response_200
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                description: Any type
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Not found
          content:
            application/json:
              schema:
                description: Any type
servers:
  - url: https://api.close.com/api/v1
components:
  schemas:
    ActivityWhatsappMessageGetParametersDateCreatedGte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersDateCreatedGte
    ActivityWhatsappMessageGetParametersDateCreatedLte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersDateCreatedLte
    ActivityWhatsappMessageGetParametersDateCreatedGt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersDateCreatedGt
    ActivityWhatsappMessageGetParametersDateCreatedLt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersDateCreatedLt
    ActivityWhatsappMessageGetParametersActivityAtGte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersActivityAtGte
    ActivityWhatsappMessageGetParametersActivityAtLte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersActivityAtLte
    ActivityWhatsappMessageGetParametersActivityAtGt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersActivityAtGt
    ActivityWhatsappMessageGetParametersActivityAtLt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityWhatsappMessageGetParametersActivityAtLt
    Attachment:
      type: object
      properties:
        content_type:
          type:
            - string
            - 'null'
        filename:
          type:
            - string
            - 'null'
        size:
          type:
            - integer
            - 'null'
        thumbnail_url:
          type:
            - string
            - 'null'
        url:
          type: string
      required:
        - content_type
        - filename
        - size
        - url
      title: Attachment
    CommunicationDirection:
      type: string
      enum:
        - incoming
        - outgoing
      description: >-
        Direction of communication. Outgoing means the communication flowing
        from the user to the lead/contact. Inbound means the opposite.
      title: CommunicationDirection
    CreationSource:
      type: string
      enum:
        - ui
        - api
        - import
        - clipper
        - email
        - suggestion
        - segment-integration
        - customerio-integration
        - calendly-integration
        - ai
        - whatsapp
        - webform
      title: CreationSource
    WhatsAppMessageActivity:
      type: object
      properties:
        _type:
          type: string
        activity_at:
          type:
            - string
            - 'null'
          format: date-time
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/Attachment'
        contact_id:
          type:
            - string
            - 'null'
        created_by:
          type:
            - string
            - 'null'
        created_by_name:
          type:
            - string
            - 'null'
        date_created:
          type: string
          format: date-time
        date_updated:
          type: string
          format: date-time
        direction:
          $ref: '#/components/schemas/CommunicationDirection'
        external_whatsapp_message_id:
          type: string
        id:
          type: string
        integration_link:
          type:
            - string
            - 'null'
        integration_name:
          type:
            - string
            - 'null'
        lead_id:
          type:
            - string
            - 'null'
        local_phone:
          type: string
        local_phone_formatted:
          type: string
        message_html:
          type: string
        message_markdown:
          type: string
        organization_id:
          type: string
        remote_phone:
          type: string
        remote_phone_formatted:
          type: string
        response_to_id:
          type:
            - string
            - 'null'
        sequence_id:
          type:
            - string
            - 'null'
        sequence_name:
          type:
            - string
            - 'null'
        sequence_subscription_id:
          type:
            - string
            - 'null'
        source:
          $ref: '#/components/schemas/CreationSource'
        text:
          type: string
        updated_by:
          type:
            - string
            - 'null'
        updated_by_name:
          type:
            - string
            - 'null'
        user_id:
          type:
            - string
            - 'null'
        user_name:
          type:
            - string
            - 'null'
        users:
          type: array
          items:
            type: string
      required:
        - _type
        - activity_at
        - contact_id
        - created_by
        - date_created
        - date_updated
        - direction
        - external_whatsapp_message_id
        - id
        - integration_link
        - integration_name
        - lead_id
        - local_phone
        - local_phone_formatted
        - message_html
        - message_markdown
        - organization_id
        - remote_phone
        - remote_phone_formatted
        - response_to_id
        - source
        - text
        - updated_by
        - user_id
        - users
      title: WhatsAppMessageActivity
    activities.whatsapp_messages_list_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WhatsAppMessageActivity'
        has_more:
          type: boolean
      required:
        - data
        - has_more
      title: activities.whatsapp_messages_list_Response_200
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: basic
      description: Use your API key as the username and leave the password empty.
    OAuth2:
      type: http
      scheme: bearer

```

## SDK Code Examples

```python activities.whatsapp_messages_list_example
import requests

url = "https://api.close.com/api/v1/activity/whatsapp_message/"

response = requests.get(url, auth=("<CLOSE_API_KEY>", ""))

print(response.json())
```

```javascript activities.whatsapp_messages_list_example
const url = 'https://api.close.com/api/v1/activity/whatsapp_message/';
const credentials = btoa("<CLOSE_API_KEY>:");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go activities.whatsapp_messages_list_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.close.com/api/v1/activity/whatsapp_message/"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<CLOSE_API_KEY>", "")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby activities.whatsapp_messages_list_example
require 'uri'
require 'net/http'

url = URI("https://api.close.com/api/v1/activity/whatsapp_message/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request.basic_auth("<CLOSE_API_KEY>", "")

response = http.request(request)
puts response.read_body
```

```java activities.whatsapp_messages_list_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.close.com/api/v1/activity/whatsapp_message/")
  .basicAuth("<CLOSE_API_KEY>", "")
  .asString();
```

```php activities.whatsapp_messages_list_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.close.com/api/v1/activity/whatsapp_message/', [
  'headers' => [
  ],
    'auth' => ['<CLOSE_API_KEY>', ''],
]);

echo $response->getBody();
```

```csharp activities.whatsapp_messages_list_example
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.close.com/api/v1/activity/whatsapp_message/");
client.Authenticator = new HttpBasicAuthenticator("<CLOSE_API_KEY>", "");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```