Accounts

List connected WhatsApp accounts

List the WhatsApp accounts attached to the calling organization. The returned business_phone_number_id is the value to use in /{phone_number_id}/... path-based endpoints (Meta-style — sender comes from the URL, not the body). Defaults to status=connected because that's the only state in which sends are accepted; pass status=all to inspect onboarding-in-progress or disconnected accounts. Response is intentionally not paginated.

get/accounts

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/accounts
  • Auth: HTTP bearer

Query parameters

status'connected' | 'all'

Account lifecycle filter. Omit for connected accounts; use all to include onboarding and disconnected accounts.

Example:connected
customer_idstring

Return accounts owned by this end-customer. Unknown or cross-organization IDs produce an empty list.

Example:cus_01HXYZABCDEFGHJKMNPQRSTVWX

Response

Account list

has_moreboolean required

Whether another page is available.

next_cursorstring nullable required

Pass this value unchanged as cursor to fetch the next page. null marks the final page.

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": [
    {
      "phone_number_id": "106540352242922",
      "phone_number": "+628111222333",
      "name": "Customer Support",
      "status": "connected",
      "meta_status": "CONNECTED",
      "customer_id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
    }
  ],
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.