Skip to main content
GET
https://api.useadam.io/v1/adam
/
oauth
/
authorization
Get authorization URL
curl --request GET \
  --url https://api.useadam.io/v1/adam/oauth/authorization \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "message": "Authorization request initiated successfully",
  "data": {
    "authorization_url": "https://app.useadam.io/auth/oauth/self?client_id=tyms_pk_example&redirect_uri=https%3A%2F%2Fyourapp.com%2Foauth%2Fcallback&reference=conn_abc123"
  }
}
Guide: OAuth 2.0. No API key on this request — only query parameters.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
client_id
string
required

Your app public key (tyms_pk_...).

​
redirect_uri
string<uri>
required

HTTPS callback URL on your app.

​
reference
string
required

Your correlation id for this authorization attempt.

​
privacy_url
string<uri>
required

Link to your app's privacy policy.

​
terms_url
string<uri>
required

Link to your app's terms of service.

Response

Authorization URL for user redirect

​
status
string
Example:

"success"

​
message
string
​
data
object