Endpoints

6

Numbers
2

Groups
1

Channels
3

What is the WhatsApp API?

Public WhatsApp data by phone number, invite link or channel: whether a number is on WhatsApp, its profile (name, about, profile picture, business profile, linked devices), what a group's invite link shows, channels with their latest posts, and the channel directory. Read-only: nothing is sent, joined or followed. Answers carry the data as WhatsApp returns it.

WhatsApp API is available on the JoJ API marketplace. Subscribe with a single JoJ API key, call it through one gateway, and pay from one wallet — no separate account or contract with the provider.

WhatsApp API endpoints

  • GET/v1/number/check

    Check Number

    Whether a phone number has a WhatsApp account, and its WhatsApp id. A number without an account is a normal answer (`registered: false`), not an error.

  • GET/v1/number/profile

    Get Profile

    Everything WhatsApp shows about the account on a phone number: the contact (`pushname`, the name the person set; `isBusiness`, `verifiedName` and, for business accounts, `businessProfile` with description, categories, website, email, address, opening hours and linked Facebook/Instagram), the about text, the profile picture URL, the account's LID and the number of devices it uses (phone plus WhatsApp Web/desktop). `about` and `profile_picture_url` are `null` when the person hides or never set them; picture URLs expire after a while. A part that could not be read is `null` and named in `unavailable`. A number with no WhatsApp account answers 404 `not_registered`.

  • GET/v1/group/invite

    Get Group by Invite Link

    What WhatsApp shows anyone who opens a group's invite link: the group's name (`subject`) and description with who set them and when, its size, creation time and creator's country, its settings (announcements only, admin-only edits, join approval), the owner, and a few participants with their phone numbers. Looking does not join the group. A code that is wrong, revoked or expired answers 404 `not_found`.

  • GET/v1/channel

    Get Channel

    A WhatsApp channel by its invite link or code: name, description, follower count (`channelMetadata.size`), verification, creation time and settings. Looking does not follow the channel.

  • GET/v1/channel/messages

    Get Channel Posts

    The latest posts of a WhatsApp channel, newest last, with their text, type, time, links and whether they carry media. Does not follow the channel.

  • GET/v1/channels/search

    Search Channels

    WhatsApp's channel directory: channels whose name matches `query`, in the countries asked for, or without a query the directory's recommended, trending, popular or new channels. Each channel comes with its follower count, verification, description and invite code (use it with Get Channel and Get Channel Posts). Channels the lookup account follows are not listed.