Customer API
- Authentication
- Account
- Lists
-
Subscribers
- List the contacts of a list
- Add a contact to a list
- Get a contact
- Change a contact
- Delete a contact
- Find a contact in every list
- Add tags to a contact
- Remove tags from a contact
- Subscribe a contact
- Unsubscribe a contact
- Unsubscribe an address from a list
- Import contacts, in the request
- Import contacts, in the background
- List the recent imports of a list
- Follow an import
- Cancel an import
- Sign a contact up, without a token
-
Campaigns
- List the campaigns
- Create a campaign
- Get a campaign
- Change a campaign
- Delete a campaign
- Send a campaign
- Pause a campaign
- Resume a paused campaign
- Download the delivery log of a campaign
- Download the opens of a campaign
- Download the clicks of a campaign
- Download the bounces of a campaign
- Download the complaints of a campaign
- Download the unsubscribes of a campaign
- List the webhooks of a campaign
- Add a webhook to a campaign
- Get a webhook of a campaign
- Change a webhook of a campaign
- Delete a webhook of a campaign
- Automations
- Bounces and complaints
Admin API
SEARCH RESULT
Navigation
Go
Maintenance Admin API
Get the version of the installation
GET
/api/v1/whoami
The user of the token and the installation it talks to. Any token may call it.
Responses
200
The user and the installation.
401
The token is missing or wrong (
Unauthenticated.), or its user may not act on
this object (Unauthorized). Without the Accept: application/json header, a
missing or wrong token answers with a redirect to the sign-in page instead.
Get the version of the installation
1
2
3
curl 'https://your-domain/api/v1/whoami' \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Response
{
"user": {
"id": 1,
"email": "admin@example.com",
"is_admin": true
},
"instance": {
"url": "https://your-domain",
"version": "4.2.0-p180"
}
}
{
"message": "Unauthenticated."
}