Retrieves a list of account objects associated with the currently authenticated user. This is a GET operation. The response is a JSON array containing metadata for each account, such as organization name and ID.
Creates a new account (organization) using the provided account input object. This is a POST operation that accepts a JSON body and returns the created account object in JSON format.
Body:
{ "organization_name": "SajMix inc # Type: string"}
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_name | string | True | The name of the organization |
Updates details, such as organization name, for the specified existing account. This is a PUT operation that accepts a JSON body and returns the updated account object.
Body:{ "id": "113 # Type: integer", "organization_name": "SajMix inc # Type: string"}
| Name | Type | Required Field | Description |
|---|---|---|---|
| id | integer | True | The numeric ID of the of the Account |
| organization_name | string | True | The name of the organization |
Retrieves a specific account by its account ID. This is a GET operation. The JSON response contains the account metadata, such as ID and organization name.
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the target account. Type: integer (int64). Must be included in the URL path. Required. |
Deletes an organization account identified by its account ID. This is a DELETE operation. Returns HTTP 200 or 204 on successful deletion.
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the target account. Type: integer (int64). Must be included in the URL path. Required. |
Removes the currently authenticated user from the specified organization. This is a GET operation. Returns HTTP 200 on successful removal.
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the of the account |
Retrieves the role of the currently authenticated user within the specified organization. This is a GET operation. The response is a string indicating the user role.
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the of the account |
Retrieves summary data for the specified organization account. This is a GET operation. The response is a JSON array containing summary metrics and statistics for the organization.
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the of the account |
Retrieves a paginated list of users associated with the specified account ID. This is a GET operation. The JSON response containing user data and pagination metadata.
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the of the account |
| page_number | integer | False | The page number to retrieve (starting from 0). Should be included in the query string. Optional. |
| page_size | integer | False | The number of records to return per page. For example: 25. Should be included in the query string. Optional. |
| sort_ascending | boolean | False | Flag indicating the sorted order of the result. True is ascending, while false is descending |
| sort_by | string | False | Flag indicating the property to which records should be sorted by |
Adds users to the specified organization account. This is a POST operation that accepts a JSON body and returns the updated account object.
Body:{ "is_active": "true # Type: boolean", "role": "CONTRIBUTOR # Type: string", "user_ids": "14,31,33,43 # Type: array"}
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the of the account |
| is_active | boolean | True | This flag determines if this user(s) accounts are activated |
| role | string | True | This is the role of a user(s) based on a particular account. Options: 'OWNER', 'ADMIN', 'CONTRIBUTOR', 'ACCOUNTING' & 'VIEWER' |
| user_ids | array | True | This is an array of user IDs (integers). Example: [14, 31, 33, 43] |
Updates user roles or access levels in the specified organization account. This is a PUT operation that accepts a JSON body and returns the updated account object.
Body:{ "is_active": "true # Type: boolean", "role": "CONTRIBUTOR # Type: string", "user_ids": "14,31,33,43 # Type: array"}
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the of the account |
| is_active | boolean | True | This flag determines if this user(s) accounts are activated |
| role | string | True | This is the role of a user(s) based on a particular account. Options: 'OWNER', 'ADMIN', 'CONTRIBUTOR', 'ACCOUNTING' & 'VIEWER' |
| user_ids | array | True | This is an array of user IDs (integers). Example: [14, 31, 33, 43] |
Removes one or more users (identified by userIds) from the specified organization account. This is a DELETE operation. Returns HTTP 200 or 204 if successful.
| Name | Type | Required Field | Description |
|---|---|---|---|
| organization_id | integer | True | The numeric ID of the of the account |
| user_ids | string | True | This property is a comma-separated string of user IDs to be removes. Type: string. Must be included in the URL path. Required. Example: 23,63,34,31,78,68 |