Flexible HTTP REST API to manage your campaign's referrals

This is the API documentation for Referkit referral engine. Most URL endpoints require OAuth2 bearer token authentication and communicate using JSON format, except the /signup and /token endpoints. All examples use CURL. Please replace the placeholder in the examples with your own access token.

<aside> 💡 GET YOUR ACCESS TOKEN

</aside>

Base URL

https://api.alphaseek.io


Customer and Authentication

You will first interact with authentication endpoints to perform administrative tasks, like registering your Alphaseek account, logging in to generate an access token used in other API requests, and changing your password.

Properties (customer)

Signup

<aside> ⚠️ Signing up is limited to beta customers. To get access, please enroll.

</aside>

Sign up endpoint requires a HTTP POST request with the body in the form of a JSON with fields email and password. Please use your business email since the email domain name will be used to create a product alias.

Example

$ curl -X POST <https://api.alphaseek.io/v0/signup> \\ 
-d '{"email": "joe@cloudseven.ai", "password": "secretHeaven7510"}' \\
-H 'Content-Type: application/json'

Login