Workspace profile
Use this endpoint to confirm which Novantra workspace a service-account token belongs to before running a synchronization job.
Get organization profile
GET /api/v1/organization
Authorization: Bearer <access-token>
Accept: application/jsonRequired scope:
| Scope | Purpose |
|---|---|
organization:read | Read the organization profile associated with the token. |
Response:
{
"organization": {
"id": "org_01hxy000000000000000000000",
"slug": "example-workspace",
"name": "Example Workspace",
"locale": "en",
"timezone": "Asia/Dubai"
}
}The organization is resolved from the bearer token. Do not send an organization ID in the request body or query string.
Next
- Authentication - issue a scoped access token.
- v1 conventions - shared response and error patterns.
Last updated on