Hodoflow / Developers
Sign in
Browse documentation
Help Center →
Browse API reference

JSON:API · v1

Account and organization

Read users, organizations, memberships, and service-account metadata.

Bearer authentication api_read / api_write by operation Stable

Operations

GET List service accounts /api/json/v1/credentials List service accounts visible to the authenticated service account. GET Retrieve a service account /api/json/v1/credentials/{id} Retrieve one service account visible to the authenticated service account. GET List organization memberships /api/json/v1/org_memberships List organization memberships visible to the authenticated service account. GET Retrieve a organization membership /api/json/v1/org_memberships/{id} Retrieve one organization membership visible to the authenticated service account. GET List organizations /api/json/v1/organizations List organizations visible to the authenticated service account. GET Retrieve a organization /api/json/v1/organizations/{id} Retrieve one organization visible to the authenticated service account. PATCH Update a organization /api/json/v1/organizations/{id} Update the supported fields of one organization. GET List users /api/json/v1/users List users visible to the authenticated service account. GET Retrieve a user /api/json/v1/users/{id} Retrieve one user visible to the authenticated service account. PATCH Update the current user profile /api/json/v1/users/{id}/profile Update the authenticated run-as user's supported profile fields.

Objects and fields

These are the reviewed public attributes. Fields omitted from this contract are not part of the API, even when they exist internally.

Organization membership type: org_membership 2 fields

Public JSON:API resource object for organization memberships.

Field Type Presence Description
is_active boolean Required Soft-delete flag. Deactivated memberships are retained for audit trail. Field included by default.
role enum: owner | admin | member Required Role returned by the public contract.
Organization type: organization 3 fields

Public JSON:API resource object for organizations.

Field Type Presence Description
domain string Required Domain returned by the public contract.
name string Required Human-readable resource name.
type enum: trial | production Required JSON:API resource type.
Service account type: credential 4 fields

Public JSON:API resource object for service accounts.

Field Type Presence Description
client_id string Required Public identifier of the service account.
is_active boolean Required Whether the resource currently accepts use.
name string Required Human-readable resource name.
scopes array<enum: webhooks | api_read | api_write | embed> Required Permissions granted to the service account.
User type: user 5 fields

Public JSON:API resource object for users.

Field Type Presence Description
email string Required Email returned by the public contract.
first_name string | null Optional · nullable User's first name. May be nil for accounts created via magic link before profile capture. Field included by default.
last_name string | null Optional · nullable User's last name. May be nil for accounts created via magic link before profile capture. Field included by default.
phone_number string | null Optional · nullable Phone number returned by the public contract.
timezone string | null Optional · nullable IANA timezone string, e.g. 'America/New_York'. Detected from browser on signup. Field included by default.