{
    "variable": [
        {
            "id": "baseUrl",
            "key": "baseUrl",
            "type": "string",
            "name": "string",
            "value": "https:\/\/hidemail.app"
        }
    ],
    "info": {
        "name": "HideMail App API",
        "_postman_id": "651ed88a-3a59-4ffa-b69e-3e23987ecf1d",
        "description": "",
        "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
    },
    "item": [
        {
            "name": "Endpoints",
            "description": "",
            "item": [
                {
                    "name": "Create a token.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/sanctum\/token",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/sanctum\/token"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"email\":\"hi@example.com\",\"password\":\"password\",\"device_name\":\"Raycast\"}"
                        },
                        "description": "This endpoint lets you create a permanent token.",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "x-ratelimit-limit",
                                    "value": "10"
                                },
                                {
                                    "key": "x-ratelimit-remaining",
                                    "value": "9"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 500,
                            "body": "{\"message\":\"The given data was invalid.\",\"status\":500}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "GET api\/user",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/user",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/user"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 401,
                            "body": "{\"message\":\"Not authenticated\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "POST api\/v1\/email\/create",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/email\/create",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/email\/create"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 401,
                            "body": "{\"message\":\"Not authenticated\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "GET api\/v1\/domain-options",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/domain-options",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/domain-options"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 401,
                            "body": "{\"message\":\"Not authenticated\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Create a new email alias.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/aliases",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/aliases"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"description\":\"My new alias\"}"
                        },
                        "description": "This endpoint lets you create a new alias."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n   \"data\": {\n     \"email\": \"alias@hidemail.app\",\n     \"note\": \"My shopping account\",\n     \"is_active\": true,\n     \"created_at\": \"2024-01-28T15:03:09.000000Z\",\n     \"updated_at\": \"2024-01-28T15:03:09.000000Z\",\n     \"total_forwarded\": 0,\n     \"total_blocked\": 0\n   }\n }",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Update an email alias note.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/aliases",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/aliases"
                        },
                        "method": "PATCH",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"note\":\"\\\"My shopping account\\\"\",\"email\":\"alias@hidemail.app\"}"
                        },
                        "description": "This endpoint allows you to update the note for a specific email alias."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"data\": {\n    \"email\": \"alias@hidemail.app\",\n    \"note\": \"My shopping account\",\n    \"is_active\": true,\n    \"created_at\": \"2024-01-28T15:03:09.000000Z\",\n    \"updated_at\": \"2024-01-28T15:03:09.000000Z\",\n    \"total_forwarded\": 0,\n    \"total_blocked\": 0\n  }\n}",
                            "name": ""
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"message\": \"Email alias not found\"\n}",
                            "name": ""
                        },
                        {
                            "header": [],
                            "code": 422,
                            "body": "{\n  \"message\": \"The note field is required.\",\n  \"errors\": {\n    \"note\": [\"The note field is required.\"]\n  }\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get all aliases.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/aliases",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/aliases"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"page\":{\"number\":12,\"size\":15},\"search\":\"gcpqikuak\",\"filter\":{\"is_active\":2},\"sort\":\"jddtcvvbvrblbijgxxqobq\",\"page[size]\":100,\"page[number]\":1}"
                        },
                        "description": "This endpoint lets you get all your aliases."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"data\":[{\"email\":\"test@relay.hidemail.app\",\"is_active\":true,\"note\":null,\"total_forwarded\":0,\"total_blocked\":0,\"created_at\":\"2023-03-01 21:04:51\",\"updated_at\":\"2025-02-25 14:02:58\"},{\"email\":\"test@relay.hidemail.app\",\"is_active\":true,\"note\":null,\"total_forwarded\":0,\"total_blocked\":0,\"created_at\":\"2023-03-01 21:04:51\",\"updated_at\":\"2025-02-25 14:02:58\"}]}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Activate an alias.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/active-aliases",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/active-aliases"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"email\":\"lyric.jaskolski@example.org\"}"
                        },
                        "description": "This endpoint lets you update the status of an alias to active."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"data\":{\"email\":\"test@relay.hidemail.app\",\"is_active\":true,\"note\":null,\"total_forwarded\":0,\"total_blocked\":0,\"created_at\":\"2023-03-01 21:04:51\",\"updated_at\":\"2025-02-25 14:02:58\"}}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Deactivate an alias.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/delete-aliases",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/delete-aliases"
                        },
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"email\":\"clinton94@example.org\"}"
                        },
                        "description": "This endpoint lets you update the status of an alias to in active."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"data\":{\"email\":\"test@relay.hidemail.app\",\"is_active\":true,\"note\":null,\"total_forwarded\":0,\"total_blocked\":0,\"created_at\":\"2023-03-01 21:04:51\",\"updated_at\":\"2025-02-25 14:02:58\"}}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Set a webhook URL.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/subscribe",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/subscribe"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"hookUrl\":\"http:\\\/\\\/rolfson.org\\\/architecto-nemo-atque-voluptatem-voluptatem-fugit-blanditiis\"}"
                        },
                        "description": "This endpoint lets you create a webhook URL. After you get email on any of your aliases we will send all data to this URL. You can do automation with this data and create your own integrations."
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 401,
                            "body": "{\"message\":\"Not authenticated\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Remove a webhook URL.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/unsubscribe",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/unsubscribe"
                        },
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "This endpoint lets you remove a webhook URL."
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 401,
                            "body": "{\"message\":\"Not authenticated\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Delete api token",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/delete-token",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/delete-token"
                        },
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "This endpoint lets you remove an api token."
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 401,
                            "body": "{\"message\":\"Not authenticated\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        }
    ],
    "auth": {
        "type": "bearer",
        "bearer": [
            {
                "key": "Authorization",
                "type": "string"
            }
        ]
    }
}