Zum Hauptinhalt springen

Einladungen

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

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

Arbeitsbereich-Einladung erstellen

POST/v1/workspaces/{workspaceId}/invites

Erstellt eine neue Arbeitsbereich-Einladung für die angegebene E-Mail-Adresse. Nur Arbeitsbereich-Administratoren und -Besitzer können Einladungen erstellen.

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID

Anfrage-Body

FeldTypErforderlichBeschreibung
emailstringJaE-Mail-Adresse der Person, die zum Arbeitsbereich eingeladen wird
rolestringJaRolle, die dem neuen Mitglied zugewiesen werden soll

Antwort

FeldTypBeschreibung
_embeddedobject
acceptingCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
inviterobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
statusstringStripe-Status der Einladung
acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde
acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat
acceptedByWorkspaceMemberIdstringID des Arbeitsbereich-Mitglieds, das die Einladung akzeptiert hat
createdAtstring
createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat
createdByUserIdstring
deniedAtstringZeitstempel, wenn die Einladung vom Eingeladenen 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, wenn 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 -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 '{
"email": "string",
"role": "string"
}'

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"
}

Arbeitsbereich-Einladung ablehnen

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

Lehnt eine Arbeitsbereich-Einladung mit dem Bestätigungscode ab. Authentifizierung ist erforderlich.

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID

Anfrage-Body

FeldTypErforderlichBeschreibung
confirmationCodestringJaDer Bestätigungscode aus der Einladungs-E-Mail

Beispiel

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 '{
"confirmationCode": "string"
}'

Antwort:

{}

Einladungs-E-Mail erneut senden

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

Sendet die Einladungs-E-Mail für eine bestimmte Einladung erneut. Nur authentifizierte Benutzer können E-Mails erneut senden.

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
inviteIdstringJaEinladungs-ID

Antwort

FeldTypBeschreibung
_embeddedobject
acceptingCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
inviterobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
statusstringStripe-Status der Einladung
acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde
acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat
acceptedByWorkspaceMemberIdstringID des Arbeitsbereich-Mitglieds, das die Einladung akzeptiert hat
createdAtstring
createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat
createdByUserIdstring
deniedAtstringZeitstempel, wenn die Einladung vom Eingeladenen 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, wenn 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 -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 '{}'

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"
}

Arbeitsbereich-Einladung akzeptieren

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

Akzeptiert eine Arbeitsbereich-Einladung mit dem Bestätigungscode. Authentifizierung ist erforderlich.

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID

Anfrage-Body

FeldTypErforderlichBeschreibung
confirmationCodestringJaDer Bestätigungscode aus der Einladungs-E-Mail

Beispiel

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 '{
"confirmationCode": "string"
}'

Antwort:

{}

Arbeitsbereich-Einladungen auflisten

GET/v1/workspaces/{workspaceId}/invites

Ruft alle Arbeitsbereich-Einladungen für einen Arbeitsbereich ab. Nur Arbeitsbereich-Administratoren und -Besitzer können Einladungen auflisten.

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID

Abfrageparameter

ParameterTypStandardBeschreibung
pendingbooleanFilter für ausstehende Einladungen (nicht storniert, nicht akzeptiert und nicht abgelaufen)

Antwort

FeldTypBeschreibung
dataarray<object>
_embeddedobject
acceptingCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
inviterobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
statusstringStripe-Status der Einladung
acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde
acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat
acceptedByWorkspaceMemberIdstringID des Arbeitsbereich-Mitglieds, das die Einladung akzeptiert hat
createdAtstring
createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat
createdByUserIdstring
deniedAtstringZeitstempel, wenn die Einladung vom Eingeladenen 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, wenn 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 "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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
}
}

Arbeitsbereich-Einladung abrufen

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

Ruft eine Arbeitsbereich-Einladung anhand ihrer ID ab. Nur Arbeitsbereich-Administratoren und -Besitzer können Einladungen anzeigen.

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
inviteIdstringJaEinladungs-ID

Antwort

FeldTypBeschreibung
_embeddedobject
acceptingCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
inviterobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
statusstringStripe-Status der Einladung
acceptedAtstringZeitstempel, wenn die Einladung akzeptiert wurde
acceptedByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung akzeptiert hat
acceptedByWorkspaceMemberIdstringID des Arbeitsbereich-Mitglieds, das die Einladung akzeptiert hat
createdAtstring
createdByLegacyCustomerIdintegerID des Legacy-Kunden, der die Einladung erstellt hat
createdByUserIdstring
deniedAtstringZeitstempel, wenn die Einladung vom Eingeladenen 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, wenn 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 "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/invites/{invite_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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"
}

Arbeitsbereich-Einladung löschen

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

Löscht eine Arbeitsbereich-Einladung anhand ihrer ID. Nur Arbeitsbereich-Administratoren und -Besitzer können Einladungen löschen. Akzeptierte Einladungen können nicht gelöscht werden.

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
inviteIdstringJaEinladungs-ID

Beispiel

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

Antwort:

{}