Einladungen

Basis-URL: https://app.neuroflash.com/api/workspace-service

Laden Sie Benutzer per E-Mail ein, einem Workspace beizutreten.

Create invites

POST/v1/workspaces/{workspaceId}/invites

Antwort

_embeddedobject

acceptingCustomerobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

inviterobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

statusstringStripeStatus der Einladung

acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde

acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat

acceptedByWorkspaceMemberIdstringID des Arbeitsbereichsmitglieds, das die Einladung akzeptiert hat

createdAtstring

createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat

createdByUserIdstring

deniedAtstringZeitstempel, wenn die Einladung vom Empfänger abgelehnt wurde

emailstringE-Mail-Adresse der Person, die zum Arbeitsbereich eingeladen wird

expiresAtstringZeitstempel, wenn die Einladung abläuft

idstring

importedFromLegacyTeamCustomerIdintegerID des Legacy-Team-Kunden, aus dem dies importiert wurde

importedFromLegacyTeamInviteIdintegerID der Legacy-Team-Einladung, aus der dies importiert wurde

resentAtarray<string>Zeitstempel, wann die Einladung erneut gesendet wurde

rolestringRolle, die dem neuen Mitglied zugewiesen werden soll

updatedAtstring

workspaceIdstringID des Arbeitsbereichs, für den die Einladung bestimmt ist

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/invites`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/invites", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "acceptingCustomer": {
      "email": "eren.jaeger@neuroflash.com",
      "hadTrial": false,
      "legacyId": 5,
      "name": "Eren Jaeger"
    },
    "inviter": {
      "email": "eren.jaeger@neuroflash.com",
      "hadTrial": false,
      "legacyId": 5,
      "name": "Eren Jaeger"
    },
    "status": "PENDING"
  },
  "acceptedAt": "2023-06-15T10:30:00Z",
  "acceptedByLegacyCustomerId": 54321,
  "acceptedByWorkspaceMemberId": "550e8400-e29b-41d4-a716-446655440001",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByLegacyCustomerId": 12345,
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "deniedAt": "2023-05-20T15:45:00Z",
  "email": "max.mustermann@neuroflash.com",
  "expiresAt": "2023-12-31T23:59:59Z",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "importedFromLegacyTeamCustomerId": 9876,
  "importedFromLegacyTeamInviteId": 7890,
  "resentAt": [
    "[\"2023-01-01T12:00:00Z\"",
    "\"2023-01-02T14:30:00Z\"]"
  ],
  "role": "MEMBER",
  "updatedAt": "2025-01-14T16:20:59Z",
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000"
}

Create denial

POST/v1/workspaces/{workspaceId}/invites/{inviteId}/denial

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}/denial" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}/denial",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/invites/${inviteId}/denial`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/invites/"+inviteID+"/denial", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{}

Create emails

POST/v1/workspaces/{workspaceId}/invites/{inviteId}/emails

Antwort

_embeddedobject

acceptingCustomerobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

inviterobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

statusstringStripeStatus der Einladung

acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde

acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat

acceptedByWorkspaceMemberIdstringID des Arbeitsbereichsmitglieds, das die Einladung akzeptiert hat

createdAtstring

createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat

createdByUserIdstring

deniedAtstringZeitstempel, wenn die Einladung vom Empfänger abgelehnt wurde

emailstringE-Mail-Adresse der Person, die zum Arbeitsbereich eingeladen wird

expiresAtstringZeitstempel, wenn die Einladung abläuft

idstring

importedFromLegacyTeamCustomerIdintegerID des Legacy-Team-Kunden, aus dem dies importiert wurde

importedFromLegacyTeamInviteIdintegerID der Legacy-Team-Einladung, aus der dies importiert wurde

resentAtarray<string>Zeitstempel, wann die Einladung erneut gesendet wurde

rolestringRolle, die dem neuen Mitglied zugewiesen werden soll

updatedAtstring

workspaceIdstringID des Arbeitsbereichs, für den die Einladung bestimmt ist

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}/emails" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}/emails",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/invites/${inviteId}/emails`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/invites/"+inviteID+"/emails", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "acceptingCustomer": {
      "email": "eren.jaeger@neuroflash.com",
      "hadTrial": false,
      "legacyId": 5,
      "name": "Eren Jaeger"
    },
    "inviter": {
      "email": "eren.jaeger@neuroflash.com",
      "hadTrial": false,
      "legacyId": 5,
      "name": "Eren Jaeger"
    },
    "status": "PENDING"
  },
  "acceptedAt": "2023-06-15T10:30:00Z",
  "acceptedByLegacyCustomerId": 54321,
  "acceptedByWorkspaceMemberId": "550e8400-e29b-41d4-a716-446655440001",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByLegacyCustomerId": 12345,
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "deniedAt": "2023-05-20T15:45:00Z",
  "email": "max.mustermann@neuroflash.com",
  "expiresAt": "2023-12-31T23:59:59Z",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "importedFromLegacyTeamCustomerId": 9876,
  "importedFromLegacyTeamInviteId": 7890,
  "resentAt": [
    "[\"2023-01-01T12:00:00Z\"",
    "\"2023-01-02T14:30:00Z\"]"
  ],
  "role": "MEMBER",
  "updatedAt": "2025-01-14T16:20:59Z",
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000"
}

Create confirmation

POST/v1/workspaces/{workspaceId}/invites/{inviteId}/confirmation

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}/confirmation" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}/confirmation",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/invites/${inviteId}/confirmation`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/invites/"+inviteID+"/confirmation", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{}

Get invites

GET/v1/workspaces/{workspaceId}/invites

Antwort

dataarray<object>

_embeddedobject

acceptingCustomerobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

inviterobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

statusstringStripeStatus der Einladung

acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde

acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat

acceptedByWorkspaceMemberIdstringID des Arbeitsbereichsmitglieds, das die Einladung akzeptiert hat

createdAtstring

createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat

createdByUserIdstring

deniedAtstringZeitstempel, wenn die Einladung vom Empfänger abgelehnt wurde

emailstringE-Mail-Adresse der Person, die zum Arbeitsbereich eingeladen wird

expiresAtstringZeitstempel, wenn die Einladung abläuft

idstring

importedFromLegacyTeamCustomerIdintegerID des Legacy-Team-Kunden, aus dem dies importiert wurde

importedFromLegacyTeamInviteIdintegerID der Legacy-Team-Einladung, aus der dies importiert wurde

resentAtarray<string>Zeitstempel, wann die Einladung erneut gesendet wurde

rolestringRolle, die dem neuen Mitglied zugewiesen werden soll

updatedAtstring

workspaceIdstringID des Arbeitsbereichs, für den die Einladung bestimmt ist

pageobject

currentPageinteger

sizeinteger

totalElementsinteger

totalPagesinteger

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/invites`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/invites", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "data": [
    {
      "_embedded": {
        "acceptingCustomer": {
          "email": "...",
          "hadTrial": "...",
          "legacyId": "...",
          "name": "..."
        },
        "inviter": {
          "email": "...",
          "hadTrial": "...",
          "legacyId": "...",
          "name": "..."
        },
        "status": "PENDING"
      },
      "acceptedAt": "2023-06-15T10:30:00Z",
      "acceptedByLegacyCustomerId": 54321,
      "acceptedByWorkspaceMemberId": "550e8400-e29b-41d4-a716-446655440001",
      "createdAt": "2025-01-14T16:20:59Z",
      "createdByLegacyCustomerId": 12345,
      "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
      "deniedAt": "2023-05-20T15:45:00Z",
      "email": "max.mustermann@neuroflash.com",
      "expiresAt": "2023-12-31T23:59:59Z",
      "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
      "importedFromLegacyTeamCustomerId": 9876,
      "importedFromLegacyTeamInviteId": 7890,
      "resentAt": [
        "[\"2023-01-01T12:00:00Z\"",
        "\"2023-01-02T14:30:00Z\"]"
      ],
      "role": "MEMBER",
      "updatedAt": "2025-01-14T16:20:59Z",
      "workspaceId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "page": {
    "currentPage": 2,
    "size": 10,
    "totalElements": 35,
    "totalPages": 4
  }
}

Get

GET/v1/workspaces/{workspaceId}/invites/{inviteId}

Antwort

_embeddedobject

acceptingCustomerobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

inviterobject

emailstringE-Mail des Kunden

hadTrialbooleanWahr, wenn der Kunde jemals eine Testphase in einem beliebigen Arbeitsbereich gestartet hat

legacyIdintegerID des Kunden im Legacy-System

namestringName des Kunden

statusstringStripeStatus der Einladung

acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde

acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat

acceptedByWorkspaceMemberIdstringID des Arbeitsbereichsmitglieds, das die Einladung akzeptiert hat

createdAtstring

createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat

createdByUserIdstring

deniedAtstringZeitstempel, wenn die Einladung vom Empfänger abgelehnt wurde

emailstringE-Mail-Adresse der Person, die zum Arbeitsbereich eingeladen wird

expiresAtstringZeitstempel, wenn die Einladung abläuft

idstring

importedFromLegacyTeamCustomerIdintegerID des Legacy-Team-Kunden, aus dem dies importiert wurde

importedFromLegacyTeamInviteIdintegerID der Legacy-Team-Einladung, aus der dies importiert wurde

resentAtarray<string>Zeitstempel, wann die Einladung erneut gesendet wurde

rolestringRolle, die dem neuen Mitglied zugewiesen werden soll

updatedAtstring

workspaceIdstringID des Arbeitsbereichs, für den die Einladung bestimmt ist

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/invites/${inviteId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/invites/"+inviteID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "acceptingCustomer": {
      "email": "eren.jaeger@neuroflash.com",
      "hadTrial": false,
      "legacyId": 5,
      "name": "Eren Jaeger"
    },
    "inviter": {
      "email": "eren.jaeger@neuroflash.com",
      "hadTrial": false,
      "legacyId": 5,
      "name": "Eren Jaeger"
    },
    "status": "PENDING"
  },
  "acceptedAt": "2023-06-15T10:30:00Z",
  "acceptedByLegacyCustomerId": 54321,
  "acceptedByWorkspaceMemberId": "550e8400-e29b-41d4-a716-446655440001",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByLegacyCustomerId": 12345,
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "deniedAt": "2023-05-20T15:45:00Z",
  "email": "max.mustermann@neuroflash.com",
  "expiresAt": "2023-12-31T23:59:59Z",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "importedFromLegacyTeamCustomerId": 9876,
  "importedFromLegacyTeamInviteId": 7890,
  "resentAt": [
    "[\"2023-01-01T12:00:00Z\"",
    "\"2023-01-02T14:30:00Z\"]"
  ],
  "role": "MEMBER",
  "updatedAt": "2025-01-14T16:20:59Z",
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000"
}

Delete

DELETE/v1/workspaces/{workspaceId}/invites/{inviteId}

Beispiel

cURL
Python
Node.js
Go

curl -X DELETE "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

requests.delete(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}",
    headers={"Authorization": f"Bearer {token}"},
)

await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/invites/${inviteId}`,
  {
    method: "DELETE",
    headers: { Authorization: `Bearer ${token}` },
  }
);

req, _ := http.NewRequest("DELETE", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/invites/"+inviteID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{}

Create invites​

Antwort​

Beispiel​

Create denial​

Beispiel​

Create emails​

Antwort​

Beispiel​

Create confirmation​

Beispiel​

Get invites​

Antwort​

Beispiel​

Get​

Antwort​

Beispiel​

Delete​

Beispiel​

Create invites

Antwort

Beispiel

Create denial

Beispiel

Create emails

Antwort

Beispiel

Create confirmation

Beispiel

Get invites

Antwort

Beispiel

Get

Antwort

Beispiel

Delete

Beispiel