Skip to main content
The Organization API lets you view who has access to your Synq tenant and invite new teammates. When you invite a user, Synq provisions a new account, assigns the role you specify, and scopes that user’s access to your organization and tenant. Every invitation is recorded in the audit log so you always have a record of who was granted access and when.
All requests require three headers: Authorization: Bearer YOUR_TOKEN, X-Tenant-ID: YOUR_TENANT_ID, and X-Org-ID: YOUR_ORG_ID. Inviting a member requires the Admin role.

​
List members

Retrieve all members currently in your tenant. GET /api/v1/organization/members

​
Headers

​
Authorization
string
required
Bearer token from your authentication provider.
​
X-Tenant-ID
string
required
UUID of your tenant.
​
X-Org-ID
string
required
UUID of your organization.

​
Response

​
[]member
array
Array of member objects scoped to your tenant.
curl https://api.synq.app/api/v1/organization/members \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "X-Org-ID: YOUR_ORG_ID"

​
Invite a member

Send an invitation to a new user. Synq provisions an account for the email address, assigns the given role, and scopes access to your tenant. The uid of the newly created account is returned so you can reference it in your own systems. POST /api/v1/organization/members
Only users with the Admin role can call this endpoint. All other roles receive 403 Forbidden.

​
Headers

​
Authorization
string
required
Bearer token from your authentication provider. The calling user must have the Admin role.
​
X-Tenant-ID
string
required
UUID of your tenant.
​
X-Org-ID
string
required
UUID of your organization.

​
Body

​
email
string
required
Email address of the person to invite. They will receive an account provisioning email at this address.
​
role
string
required
Role to assign to the invited user. Must be a non-empty string. Common values:
  • ADMIN — full management access, including inviting other members and updating settings.
  • EDITOR — read/write access to products, orders, and inventory.
  • VIEWER — read-only access.

​
Response

Returns 201 Created with the new user’s UID.
​
message
string
Confirmation message: User successfully invited.
​
uid
string
The UID of the newly provisioned user account.
curl -X POST https://api.synq.app/api/v1/organization/members \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "X-Org-ID: YOUR_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dana@example.com",
    "role": "EDITOR"
  }'