Skip to main content
POST
/
v1
/
auth
/
register-app
Register an app
curl --request POST \
  --url https://api.vendaze.com/v1/auth/register-app \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_name": "My SaaS",
  "email": "dev@mysaas.com",
  "redirect_uris": [
    "https://mysaas.com/callback/vendaze"
  ],
  "scopes": [
    "people:read",
    "deals:write"
  ],
  "description": "Integration with Vendaze to sync contacts.",
  "avatar_url": "https://mysaas.com/assets/vendaze-avatar.webp"
}
'
{
  "data": {
    "app_name": "My SaaS",
    "client_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
    "message": "Credentials sent to dev@mysaas.com"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
app_name
string
required
Maximum string length: 100
Example:

"My SaaS"

​
email
string<email>
required
Example:

"dev@mysaas.com"

​
redirect_uris
string<uri>[]
required
Example:
["https://mysaas.com/callback/vendaze"]
​
scopes
enum<string>[]
required

Scopes your app needs. Users approve them individually on the consent screen.

A single OAuth scope value.

Available options:
people:read,
people:write,
companies:read,
companies:write,
deals:read,
deals:write,
tasks:read,
tasks:write,
activities:read,
activities:write,
products:read,
products:write,
tags:read,
tags:write,
lists:read,
lists:write,
custom_fields:read,
custom_fields:write
Example:
["people:read", "deals:write"]
​
description
string
Maximum string length: 500
Example:

"Integration with Vendaze to sync contacts."

​
avatar_url
string<uri>

URL of the app avatar shown on the consent screen. Must be a publicly accessible HTTPS URL pointing to a WebP image. Maximum dimensions: 400x400 px.

Example:

"https://mysaas.com/assets/vendaze-avatar.webp"

Response

App registered successfully.

​
data
object