Applications & Credentials API — SyncNexa Docs

The Applications API enables automated provisioning of client apps, environments, secret keys, and webhook endpoints.

List Applications

GET/org/v1/apps

Bearer Auth

List Organization Applications

Returns a paginated list of all active applications under the authenticated organization.

curl

1 curl -X GET "https://api.business.syncnexa.co/org/v1/apps" \
2   -H "Authorization: Bearer sk_live_YOUR_SECRET_KEY"

response-200.jsonjson

1 {
2   "success": true,
3   "data": [
4     {
5       "id": "app_8a7b6c5d4e3f",
6       "name": "Student Discount Store",
7       "environment": "live",
8       "status": "active",
9       "createdAt": "2026-08-10T14:32:00.000Z",
10       "webhookCount": 1,
11       "keyCount": 2
12     }
13   ]
14 }

Create Application

POST/org/v1/apps

Bearer Auth

Create New Application

Creates a new application container and optionally registers a webhook endpoint and event subscriptions in a single atomic transaction.

Parameter	Type	Required	Description
`name`	string	Required	Human-readable name of the application. Example: `Acme Campus Store`
`environment`	string	Optional	Target environment: "sandbox" or "live". Default: `sandbox` Example: `sandbox`
`description`	string	Optional	Optional internal description or notes. Example: `Point of sale terminal at Main Campus`
`webhookUrl`	string	Optional	Optional HTTPS webhook URL to register with the application. Example: `https://api.acmestore.com/webhooks/syncnexa`
`webhookEvents`	string[]	Optional	Array of event names to subscribe to when webhookUrl is provided. Example: `["verification.completed", "verification.failed"]`

create-app-request.jsonjson

1 {
2   "name": "Acme Campus Store",
3   "environment": "sandbox",
4   "webhookUrl": "https://api.acmestore.com/webhooks/syncnexa",
5   "webhookEvents": ["verification.completed", "consent.approved"]
6 }

Get Application Details

GET/org/v1/apps/:appId

Bearer Auth

Retrieve Application Metadata

Fetches detailed configuration, credential counts, and metrics for a single application.

Generate API Key

POST/org/v1/keys

Bearer Auth

Generate API Key

Generates a new sk_test_ or sk_live_ secret key for the specified application. Returns the unmasked rawSecret once.

Parameter Type Required Description

Parameter	Type	Required	Description
`appId`	string	Required	The target Application UUID. Example: `app_8a7b6c5d4e3f`
`name`	string	Required	Label describing what system or server uses this key. Example: `Production Backend API`
`environment`	string	Required	"sandbox" generates sk_test_... or "live" generates sk_live_... Example: `live`

appId

string

Required

The target Application UUID.

Example: app_8a7b6c5d4e3f

name

string

Required

Label describing what system or server uses this key.

Example: Production Backend API

environment

string

Required

"sandbox" generates sk_test_... or "live" generates sk_live_...

Example: live

create-key-response.jsonjson

1 {
2   "success": true,
3   "data": {
4     "id": "key_9b8a7c6d5e4f",
5     "appId": "app_8a7b6c5d4e3f",
6     "name": "Production Backend API",
7     "environment": "live",
8     "keyHint": "sk_live_****3b4c",
9     "rawSecret": "sk_live_YOUR_SECRET_KEY",
10     "createdAt": "2026-08-20T12:20:00.000Z"
11   }
12 }

Revoke API Key

DELETE/org/v1/keys/:keyId

Bearer Auth

Revoke API Key

Permanently deletes and blacklists an API key. Any future requests using this key will immediately fail with HTTP 401.

Was this page helpful?

1	curl -X GET "https://api.business.syncnexa.co/org/v1/apps" \
2	-H "Authorization: Bearer sk_live_YOUR_SECRET_KEY"

1	{
2	"success": true,
3	"data": [
4	{
5	"id": "app_8a7b6c5d4e3f",
6	"name": "Student Discount Store",
7	"environment": "live",
8	"status": "active",
9	"createdAt": "2026-08-10T14:32:00.000Z",
10	"webhookCount": 1,
11	"keyCount": 2
12	}
13	]
14	}

1	{
2	"name": "Acme Campus Store",
3	"environment": "sandbox",
4	"webhookUrl": "https://api.acmestore.com/webhooks/syncnexa",
5	"webhookEvents": ["verification.completed", "consent.approved"]
6	}

1	{
2	"success": true,
3	"data": {
4	"id": "key_9b8a7c6d5e4f",
5	"appId": "app_8a7b6c5d4e3f",
6	"name": "Production Backend API",
7	"environment": "live",
8	"keyHint": "sk_live_****3b4c",
9	"rawSecret": "sk_live_YOUR_SECRET_KEY",
10	"createdAt": "2026-08-20T12:20:00.000Z"
11	}
12	}