api-docs v5.45.0

API Docs

Account_Invitation

Organization Membership - Post

Back to top

Create an account invitation for an organization member

POST /account-invitations

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
email string
expiresAt number optional
reward object optional
reward.type string Allowed values: storage,trial-extension
reward.amount number
type string Allowed values: org-membership
member object

organizationMember object

Examples

Example usage:

curl "https://yourdomain.com/account-invitations" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "org-membership",
    "email": "someemail@email.com",
    "member": {
      "externalId": "external-1"
    }
  }'

Parameters examples

json - Request-Example

{
  "type": "org-membership",
  "email": "someemail@email.com",
  "member": {
    "externalId": "external-1"
  }
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: org-membership
member object

organizationMember object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "org-membership"
}

Patient Membership - Post

Back to top

Create an account invitation for a patient

POST /account-invitations

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
email string
expiresAt number optional
reward object optional
reward.type string Allowed values: storage,trial-extension
reward.amount number
type string Allowed values: patient
patient string

patient id

Examples

Example usage:

curl "https://yourdomain.com/account-invitations" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "patient",
    "email": "someemail@email.com",
    "patient": "patient-id"
  }'

Parameters examples

json - Request-Example

{
  "type": "patient",
  "email": "someemail@email.com",
  "patient": "patient-id"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: patient
patient string

patient id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "patient"
}

Organization Membership - Delete

Back to top

Delete specific organization membership account invitation

DELETE /account-invitations/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/account-invitations/<account-invitation-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: org-membership
member object

organizationMember object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "org-membership"
}

Patient Membership - Delete

Back to top

Delete specific patient membership account invitation

DELETE /account-invitations/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/account-invitations/<account-invitation-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: patient
patient string

patient id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "patient"
}

Organization Membership - Find

Back to top

Get list of organization membership account invitations

GET /account-invitations

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/account-invitations?type=org-membership" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
accountInvitations object[]

array of account invitation
accountInvitations.id string
accountInvitations.createdAt number

timestamp
accountInvitations.createdBy string

account uid
accountInvitations.email string
accountInvitations.expiresAt number

timestamp
accountInvitations.acceptedAt number

timestamp
accountInvitations.reward object
accountInvitations.reward.type string
accountInvitations.reward.amount number
accountInvitations.type string Allowed values: org-membership
accountInvitations.member object

organizationMember object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "account-invitation-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "type": "org-membership"
  },
  {
    "id": "account-invitation-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "type": "org-membership"
  }
]

Patient Membership - Find

Back to top

Get list of patient membership account invitations

GET /account-invitations

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/account-invitations?type=patient" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
accountInvitations object[]

array of account invitation
accountInvitations.id string
accountInvitations.createdAt number

timestamp
accountInvitations.createdBy string

account uid
accountInvitations.email string
accountInvitations.expiresAt number

timestamp
accountInvitations.acceptedAt number

timestamp
accountInvitations.reward object
accountInvitations.reward.type string
accountInvitations.reward.amount number
accountInvitations.type string Allowed values: patient
accountInvitations.patient string

patient id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "account-invitation-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "type": "patient"
  },
  {
    "id": "account-invitation-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "type": "patient"
  }
]

Organization Membership - Get

Back to top

Get specific organization membership account invitation

GET /account-invitations/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/account-invitations/<account-invitation-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: org-membership
member object

organizationMember object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "org-membership"
}

Patient Membership - Get

Back to top

Get specific patient membership account invitation

GET /account-invitations/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/account-invitations/<account-invitation-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: patient
patient string

patient id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "patient"
}

Organization Membership - Patch

Back to top

Update an organization membership account invitation

PATCH /account-invitations/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
accept boolean optional

directive: accept an invitation
resend boolean optional

directive: for resending email

Examples

Example usage:

curl "https://yourdomain.com/account-invitations/<account-invitation-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "accept": true
  }'

Parameters examples

json - Request-Example

{
  "accept": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: org-membership
member object

organizationMember object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "org-membership"
}

Patient Membership - Patch

Back to top

Update a patient membership account invitation

PATCH /account-invitations/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
accept boolean optional

directive: accept an invitation
resend boolean optional

directive: for resending email

Examples

Example usage:

curl "https://yourdomain.com/account-invitations/<account-invitation-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "accept": true
  }'

Parameters examples

json - Request-Example

{
  "accept": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
email string
expiresAt number

timestamp
acceptedAt number

timestamp
reward object
reward.type string
reward.amount number
type string Allowed values: patient
patient string

patient id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-invitation-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "patient"
}

results matching ""

    No results matching ""