Public
Documentation Settings
No Environment
Double Column
cURL - cURL
API documentation
Introduction
POST
Invitation API
POST
Suspend a user
GET
User Information
GET
User Information - get user
GET
Room Information
GET
Attendance Data

API documentation

POSTInvitation API

{{baseURL}}/User/Invitation
HEADERS
V-Client-Id

{{Client-ID}}

V-Client-Secret

{{Client-Secret}}

Bodyraw (json)
json
{
  "email": "bill.mchenry+20221004@virbela.com,
  "displayName": "TestUser" ,
  "firstName": "Test" , 
  "lastName": "User" ,
  "Title": "User for testing puposes" ,
  "teamId": "A",
  "permission": "Moderator",
  "sendInvitationEmail": "all"
}
Example Request
Invitation API
curl
curl --location -g '{{baseURL}}/User/Invitation' \
--header 'V-Client-Id: {{Client-ID}}' \
--header 'V-Client-Secret: {{Client-Secret}}' \
--data-raw '{
    "email": "bill.mchenry+test20221004@virbela.com",
    "teamId": "1",
    "permission": "Moderator",
    "sendInvitationEmail": "all"
}'
201 Created
Example Response
json
{
  "responseCode": "success",
  "title": "Invitation was created and sent",
  "detail": "New user (bill.mchenry+test20221004@virbela.com) was successfully invited.",
  "data": {
    "email": "bill.mchenry+test20221004@virbela.com",
    "accountId": "GUymFe10IM",
    "permission": "Moderator",
    "teamId": "1",
    "sendTarget": "all",
    "profileFields": {}
  },
  "requestId": "63482bbd9bccbe2235d1be05"
}
Content-Type

application/json; charset=utf-8

Content-Length

351

Connection

keep-alive

Date

Thu, 13 Oct 2022 15:16:15 GMT

x-amzn-RequestId

a0e66d82-2c7b-42a2-8a23-a316923a8ada

Access-Control-Allow-Origin

*

x-amzn-Remapped-Content-Length

351

x-amzn-Remapped-Connection

keep-alive

x-amz-apigw-id

Z8vFmG2aFiAFbVg=

Vary

Accept-Encoding

x-amzn-Remapped-Server

nginx/1.20.0

X-Powered-By

Express

ETag

W/"15f-aNcLalBFiYcS9KzgeN1/E9eX50c"

x-amzn-Remapped-Date

Thu, 13 Oct 2022 15:16:15 GMT

X-Cache

Miss from cloudfront

Via

1.1 afd822e99baebd9321fa9aa8f9350e78.cloudfront.net (CloudFront)

X-Amz-Cf-Pop

IAD55-P5

X-Amz-Cf-Id

t2u4df05-aom_0okNkChZA15JP1YWGTqppaq7Lu5e5NjjdOG6HYL3g==

POSTSuspend a user

{{baseURL}}/User/Membership/suspend
HEADERS
V-Client-Id

{{Client-ID}}

V-Client-Secret

{{Client-Secret}}

Bodyraw (json)
json
{
  "email": "bill.mchenry+20221004@virbela.com"
}
Example Request
Invitation API
curl
curl --location -g '{{baseURL}}/User/Invitation' \
--header 'V-Client-Id: {{Client-ID}}' \
--header 'V-Client-Secret: {{Client-Secret}}' \
--data-raw '{
    "email": "bill.mchenry+test20221004@virbela.com",
    "teamId": "1",
    "permission": "Moderator",
    "sendInvitationEmail": "all"
}'
201 Created
Example Response
json
{
  "responseCode": "success",
  "title": "Invitation was created and sent",
  "detail": "New user (bill.mchenry+test20221004@virbela.com) was successfully invited.",
  "data": {
    "email": "bill.mchenry+test20221004@virbela.com",
    "accountId": "GUymFe10IM",
    "permission": "Moderator",
    "teamId": "1",
    "sendTarget": "all",
    "profileFields": {}
  },
  "requestId": "63482bbd9bccbe2235d1be05"
}
Content-Type

application/json; charset=utf-8

Content-Length

351

Connection

keep-alive

Date

Thu, 13 Oct 2022 15:16:15 GMT

x-amzn-RequestId

a0e66d82-2c7b-42a2-8a23-a316923a8ada

Access-Control-Allow-Origin

*

x-amzn-Remapped-Content-Length

351

x-amzn-Remapped-Connection

keep-alive

x-amz-apigw-id

Z8vFmG2aFiAFbVg=

Vary

Accept-Encoding

x-amzn-Remapped-Server

nginx/1.20.0

X-Powered-By

Express

ETag

W/"15f-aNcLalBFiYcS9KzgeN1/E9eX50c"

x-amzn-Remapped-Date

Thu, 13 Oct 2022 15:16:15 GMT

X-Cache

Miss from cloudfront

Via

1.1 afd822e99baebd9321fa9aa8f9350e78.cloudfront.net (CloudFront)

X-Amz-Cf-Pop

IAD55-P5

X-Amz-Cf-Id

t2u4df05-aom_0okNkChZA15JP1YWGTqppaq7Lu5e5NjjdOG6HYL3g==

GETUser Information

{{baseURL}}/User?limit=2000&Skip=0
HEADERS
V-Client-Id

{{Client-ID}}

V-Client-Secret

{{Client-Secret}}

PARAMS
limit

2000

Skip

0

Example Request
User Information
curl
curl --location -g '{{baseURL}}/User?limit=2000&Skip=0' \
--header 'V-Client-Id: {{Client-ID}}' \
--header 'V-Client-Secret: {{Client-Secret}}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETUser Information - get user

{{baseURL}}/User/XLC5C2tgog
HEADERS
V-Client-Id

{{Client-ID}}

V-Client-Secret

{{Client-Secret}}

Example Request
User Information - get user
curl
curl --location -g '{{baseURL}}/User/XLC5C2tgog' \
--header 'V-Client-Id: {{Client-ID}}' \
--header 'V-Client-Secret: {{Client-Secret}}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers