...
APIs for organization administration
...
Accounts
Returns list of all active accounts in your organization
| Expand |
|---|
| title | GET https://<base-url>/ClientsAccounts |
|---|
|
Headers: ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5 Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE | Info |
|---|
ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access |
|
| Expand |
|---|
| title | Response (status 200) |
|---|
|
| Code Block |
|---|
| [
{
"id": "41a31538-1120-4bdf-a6cb-675eeedd7d2d",
"firstName": "Nathan",
"lastName": "Bray",
"email": "nathan.bray@connectmyapps.com",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationName": "CMA Customer Bench",
"roleId": "349889ad-4277-42d0-a268-5cd27230cfc5",
"role": "User",
"dateCreated": "2020-05-07T19:10:36.69"
},
{
"id": "18cc3b9f-c14e-4c7d-892b-7cc5545abac0",
"firstName": "Igor",
"lastName": "Kostian",
"email": "igor.kostian@connectmyapps.com",
"organizationId": "00000000-0000-0000-0000-000000000001",
"organizationName": "ConnectMyApps AS",
"roleId": "9c525665-df99-4aee-9e52-1a55853db03b",
"role": "Admin",
"dateCreated": "2017-03-01T08:51:32.31"
},
{
"id": "a305c3a2-cba5-4554-bb5d-ab7fcd5b4a4c",
"firstName": "Luke",
"lastName": "Buckley",
"email": "luke.buckley@connectmyapps.com",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationName": "CMA Customer Bench",
"roleId": "9c525665-df99-4aee-9e52-1a55853db03b",
"role": "Admin",
"dateCreated": "2013-06-01T18:56:22.763"
}
] |
|
Account
Registers a new inactive account and returns account Id. The email to complete activation will be send by corresponded address.
| Expand |
|---|
| title | POST https://<base-url>/Account |
|---|
|
Body JSON structure: AddAccountApiDto Body example: | Code Block |
|---|
| {
"firstName": "John",
"lastName": "Smeet",
"email": "john.smmet@сompany.com",
"phone":"+470568765432",
"roleName":"SuperPartner",
"countryKey":"DE",
"globalNotifications":true,
"defaultNotificationEmail":"support@connectmyapps.com"
} |
Headers: ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5 Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE | Info |
|---|
ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access |
|
| Expand |
|---|
| title | Response (status 200) |
|---|
|
| Code Block |
|---|
| "296dce4a-3e24-495e-833c-e183ccfbf2d9" |
|
| Expand |
|---|
| title | Response (status 401) |
|---|
|
Status Code: 401; Unauthorized |
| Expand |
|---|
| title | Response (status 400) |
|---|
|
| Code Block |
|---|
Account has already been created |
|
| Expand |
|---|
| title | Response (status 400) |
|---|
|
| Code Block |
|---|
Role Admin is not supported. Please use SuperPartner or User |
|
Application APIs
Applications
...