Hide-My-Email.info API Documentation
All documents

Friends and Groups

All endpoints in this document require secret: sk1_... and x-account-access-id: aid1.....

Friends

List friends

GET /api/v1/friends

Returns the account's saved recipients ("friends") that can be reused in compose and forwarding flows.

Response fields

  • []
  • [].id
  • [].name
  • [].emails[]
  • [].isFavorite
  • [].aliasId
  • [].aliasAddress

Response codes

  • 200 OK
  • 401 Unauthorized

Example

curl "http://Hide-My-Email.info/api/v1/friends" -H "secret: sk1_example"

Read one friend

`GET /api/v1/friends/

Returns one saved recipient entry owned by the authenticated account.

Path parameters

  • friendId

Response fields

  • id
  • name
  • emails[]
  • isFavorite
  • aliasId
  • aliasAddress

Response codes

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found

Example

curl "http://Hide-My-Email.info/api/v1/friends/friend_123" -H "secret: sk1_example"

Read alias generation capability

GET /api/v1/friends/alias-generation-capability

Returns whether the current account can automatically generate a new alias while working with friend-related flows.

Response fields

  • canGenerateNewAlias

Example

curl "http://Hide-My-Email.info/api/v1/friends/alias-generation-capability" -H "secret: sk1_example"

Create friend

POST /api/v1/friends

Creates a saved recipient entry for reuse in compose, forwarding, and group membership flows.

Request body fields

  • name
  • emailsCsv
  • isFavorite
  • aliasId

Response fields

  • success
  • message
  • friend
  • friend.id
  • friend.name
  • friend.emails[]
  • friend.isFavorite
  • friend.aliasId
  • friend.aliasAddress

Response codes

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized

Example

curl -X POST "http://Hide-My-Email.info/api/v1/friends" \
  -H "secret: sk1_example" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"Alice\",\"emailsCsv\":\"alice@example.com,billing@example.com\",\"isFavorite\":false,\"aliasId\":null}"

Update friend

`PUT /api/v1/friends/

Updates one saved recipient entry owned by the authenticated account.

Path parameters

  • friendId

Request body fields

  • name
  • emailsCsv
  • isFavorite
  • aliasId

Response fields

  • success
  • message
  • friend

Example

curl -X PUT "http://Hide-My-Email.info/api/v1/friends/friend_123" \
  -H "secret: sk1_example" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"Alice\",\"emailsCsv\":\"alice@example.com\",\"isFavorite\":true,\"aliasId\":\"alias_123\"}"

Delete friend

`DELETE /api/v1/friends/

Deletes one saved recipient entry owned by the authenticated account.

Path parameters

  • friendId

Response fields

  • success
  • message

Example

curl -X DELETE "http://Hide-My-Email.info/api/v1/friends/friend_123" -H "secret: sk1_example"

Groups under /api/v1/groups

List groups

GET /api/v1/groups

Returns the normalized group API view for the authenticated account. This is the current preferred groups route family.

Headers

  • secret: sk1_...

Path parameters

  • None

Query parameters

  • None

Request body

  • None

Response fields

  • []
  • [].id
  • [].name
  • [].isFavorite
  • [].memberCount
  • [].ignoreEmailsOutsideGroup
  • [].aliasId
  • [].aliasAddress
  • [].groupGuid

Response codes

  • 200 OK
  • 401 Unauthorized

Example

curl "http://Hide-My-Email.info/api/v1/groups" -H "secret: sk1_example"

Read one group

`GET /api/v1/groups/

Returns one group owned by the authenticated account.

Path parameters

  • groupId

Response fields

  • id
  • name
  • isFavorite
  • memberCount
  • ignoreEmailsOutsideGroup
  • aliasId
  • aliasAddress
  • groupGuid

Response codes

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found

Example

curl "http://Hide-My-Email.info/api/v1/groups/group_123" -H "secret: sk1_example"

Create group

POST /api/v1/groups

Creates a group using the current normalized groups API route family.

Headers

  • secret: sk1_...
  • Content-Type: application/json

Path parameters

  • None

Query parameters

  • None

Request body fields

  • name
  • isFavorite
  • ignoreEmailsOutsideGroup
  • aliasId

Response fields

  • success
  • message
  • group

Response codes

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized

Example

curl -X POST "http://Hide-My-Email.info/api/v1/groups" \
  -H "secret: sk1_example" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"Customers\",\"isFavorite\":false,\"ignoreEmailsOutsideGroup\":true,\"aliasId\":null}"

Update group

`PUT /api/v1/groups/

Updates a group using the current normalized groups API route family.

Headers

  • secret: sk1_...
  • Content-Type: application/json

Path parameters

  • groupId

Query parameters

  • None

Request body fields

  • name
  • isFavorite
  • ignoreEmailsOutsideGroup
  • aliasId

Response fields

  • success
  • message
  • group

Response codes

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found

Example

curl -X PUT "http://Hide-My-Email.info/api/v1/groups/group_123" \
  -H "secret: sk1_example" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"Customers\",\"isFavorite\":true,\"ignoreEmailsOutsideGroup\":true,\"aliasId\":\"alias_123\"}"

Delete group

`DELETE /api/v1/groups/

Deletes a group using the current normalized groups API route family.

Headers

  • secret: sk1_...

Path parameters

  • groupId

Query parameters

  • None

Request body

  • None

Response fields

  • success
  • message

Response codes

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found

Example

curl -X DELETE "http://Hide-My-Email.info/api/v1/groups/group_123" -H "secret: sk1_example"

List group members

`GET /api/v1/groups/

Returns the current member selection state for all friends in one group.

Headers

  • secret: sk1_...

Path parameters

  • groupId

Query parameters

  • None

Request body

  • None

Response fields

  • []
  • [].friendId
  • [].friendName
  • [].isMember

Response codes

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found

Example

curl "http://Hide-My-Email.info/api/v1/groups/group_123/friends" -H "secret: sk1_example"

Replace group membership in bulk

`PUT /api/v1/groups/

Replaces the full friend membership set of a group with the provided friend identifier list.

Request body fields

  • friendIds[] - required list of friend identifiers

Response fields

  • success
  • message
  • group

Response codes

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found

Example

curl -X PUT "http://Hide-My-Email.info/api/v1/groups/group_123/friends" \
  -H "secret: sk1_example" \
  -H "Content-Type: application/json" \
  -d "{\"friendIds\":[\"friend_1\",\"friend_2\"]}"

Update one friend membership

`PUT /api/v1/groups/

Adds or removes exactly one friend from one group using the current normalized groups route family.

Query parameters

  • isMember - required boolean

Response fields

  • success
  • message
  • group

Response codes

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found

Example

curl -X PUT "http://Hide-My-Email.info/api/v1/groups/group_123/friends/friend_1?isMember=true" \
  -H "secret: sk1_example"
© 2026 PrivacyGuard.company. All rights reserved.