/comments

get /comments

                curl "/comments" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/comments',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /comments

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number

/files

get /files

                curl "/files" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/files',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /files

TAGS

/practices

get /practices

                curl "/practices" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/practices',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /practices

TAGS

Query String

Key	Type	Description	Allowed Values
organization_id	number

/templates

get /templates

                curl "/templates" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/templates',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /templates

TAGS

/user

get /user

                curl "/user" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/user',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /user

TAGS

/user

put /user

                curl "/user" \
                    -H "Content-Type: application/json" \
                    -d '{
	"idToken": "qux",
	"refreshToken": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/user',
    json: true,
    body: '{
	"idToken": "qux",
	"refreshToken": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /user

TAGS

JSON Payload

Key	Type	Description	Allowed Values
idToken	string
refreshToken	string
updates	object

/version

get /version

                curl "/version" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/version',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /version

TAGS

/billing/getCustomer

get /billing/getCustomer

                curl "/billing/getCustomer" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/billing/getCustomer',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /billing/getCustomer

TAGS

/billing/price

get /billing/price

                curl "/billing/price" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/billing/price',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /billing/price

TAGS

/comment/{comment_id}

get /comment/123

                curl "/comment/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/comment/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /comment/{comment_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
comment_id	number

/comment/{comment_id}

put /comment/123

                curl "/comment/123" \
                    -H "Content-Type: application/json" \
                    -d '{
	"body": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/comment/123',
    json: true,
    body: '{
	"body": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /comment/{comment_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
comment_id	number

JSON Payload

Key	Type	Description	Allowed Values
body	string

/comment/{comment_id}

delete /comment/123

                curl "/comment/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'delete',
    path: '/comment/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

delete /comment/{comment_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
comment_id	number

/criterion/statuses

get /criterion/statuses

                curl "/criterion/statuses" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/criterion/statuses',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /criterion/statuses

TAGS

/criterion/{criterion_id}

get /criterion/123

                curl "/criterion/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/criterion/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /criterion/{criterion_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number

/criterion/{criterion_id}

put /criterion/123

                curl "/criterion/123" \
                    -H "Content-Type: application/json" \
                    -d '{
	"status": "qux",
	"checkin": 123,
	"planned": true,
	"components": 123
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/criterion/123',
    json: true,
    body: '{
	"status": "qux",
	"checkin": 123,
	"planned": true,
	"components": 123
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /criterion/{criterion_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number

JSON Payload

Key	Type	Description	Allowed Values
status	string
checkin	number
planned	boolean
components	number
value	object

/event/{event_id}

get /event/{event_id}

                curl "/event/{event_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/event/{event_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /event/{event_id}

TAGS

/event/{event_id}

put /event/{event_id}

                curl "/event/{event_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/event/{event_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /event/{event_id}

TAGS

/event/{event_id}

delete /event/{event_id}

                curl "/event/{event_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'delete',
    path: '/event/{event_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

delete /event/{event_id}

TAGS

/file/{file_id}

get /file/{file_id}

                curl "/file/{file_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/file/{file_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /file/{file_id}

TAGS

/file/{file_id}

put /file/{file_id}

                curl "/file/{file_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/file/{file_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /file/{file_id}

TAGS

/files/generate_download_link

get /files/generate_download_link

                curl "/files/generate_download_link" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/files/generate_download_link',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /files/generate_download_link

TAGS

/files/{org_id}

get /files/{org_id}

                curl "/files/{org_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/files/{org_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /files/{org_id}

TAGS

/group/consultants

get /group/consultants

                curl "/group/consultants" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/consultants',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/consultants

TAGS

/group/details

get /group/details

                curl "/group/details" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/details',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/details

TAGS

/group/events

get /group/events

                curl "/group/events" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/events',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/events

TAGS

/group/organizations

get /group/organizations

                curl "/group/organizations" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/organizations',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/organizations

TAGS

/group/orgmetrics

get /group/orgmetrics

                curl "/group/orgmetrics" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/orgmetrics',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/orgmetrics

TAGS

/organization/{organization_id}

get /organization/123

                curl "/organization/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}

put /organization/123

                curl "/organization/123" \
                    -H "Content-Type: application/json" \
                    -d '{
	"name": "qux",
	"abbreviation": "qux",
	"is_archived": true
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/organization/123',
    json: true,
    body: '{
	"name": "qux",
	"abbreviation": "qux",
	"is_archived": true
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /organization/{organization_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

JSON Payload

Key	Type	Description	Allowed Values
name	string
abbreviation	string
is_archived	boolean

/organization/{organization_id}

delete /organization/123

                curl "/organization/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'delete',
    path: '/organization/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

delete /organization/{organization_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/practice/{practice_id}

get /practice/123

                curl "/practice/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/practice/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /practice/{practice_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
practice_id	number

/practice/{practice_id}

put /practice/123

                curl "/practice/123" \
                    -H "Content-Type: application/json" \
                    -d '{
	"name": "qux",
	"primary_practice": true,
	"practice_lead": "qux",
	"abbreviation": "qux",
	"region": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/practice/123',
    json: true,
    body: '{
	"name": "qux",
	"primary_practice": true,
	"practice_lead": "qux",
	"abbreviation": "qux",
	"region": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

Update a practice

HTTP REQUEST

put /practice/{practice_id}

TAGS

• update
• practice

URI Components

Key	Type	Description	Allowed Values
practice_id	number

JSON Payload

Key	Type	Description	Allowed Values
name	string
primary_practice	boolean
practice_lead	string
abbreviation	string
region	string

/practice/{practice_id}

delete /practice/{practice_id}

                curl "/practice/{practice_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'delete',
    path: '/practice/{practice_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

delete /practice/{practice_id}

TAGS

/templates/getAnnualYears

get /templates/getAnnualYears

                curl "/templates/getAnnualYears" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/templates/getAnnualYears',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /templates/getAnnualYears

TAGS

/templates/getInitialYears

get /templates/getInitialYears

                curl "/templates/getInitialYears" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/templates/getInitialYears',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /templates/getInitialYears

TAGS

/templates/getLatestInitialTemplates

get /templates/getLatestInitialTemplates

                curl "/templates/getLatestInitialTemplates" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/templates/getLatestInitialTemplates',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /templates/getLatestInitialTemplates

TAGS

/templates/{template_name}

get /templates/{template_name}

                curl "/templates/{template_name}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/templates/{template_name}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /templates/{template_name}

TAGS

/user/roles

get /user/roles

                curl "/user/roles" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/user/roles',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /user/roles

TAGS

/criterion/{criterion_id}/comments

get /criterion/123/comments

                curl "/criterion/123/comments" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/criterion/123/comments',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /criterion/{criterion_id}/comments

TAGS

Query String

Key	Type	Description	Allowed Values
limit	number

URI Components

Key	Type	Description	Allowed Values
criterion_id	number

/criterion/{criterion_id}/files

get /criterion/123/files

                curl "/criterion/123/files" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/criterion/123/files',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /criterion/{criterion_id}/files

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number

/event/{event_id}/criteria

get /event/123/criteria

                curl "/event/123/criteria" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/event/123/criteria',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /event/{event_id}/criteria

TAGS

URI Components

Key	Type	Description	Allowed Values
event_id	number

/group/annual/events

get /group/annual/events

                curl "/group/annual/events" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/annual/events',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/annual/events

TAGS

/group/annual/organizations

get /group/annual/organizations

                curl "/group/annual/organizations" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/annual/organizations',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/annual/organizations

TAGS

/group/annual/orgmetrics

get /group/annual/orgmetrics

                curl "/group/annual/orgmetrics" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/group/annual/orgmetrics',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /group/annual/orgmetrics

TAGS

/organization/annual/{organization_id}

get /organization/annual/123

                curl "/organization/annual/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/annual/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/annual/{organization_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}/members

get /organization/123/members

                curl "/organization/123/members" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/members',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/members

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}/admins

get /organization/123/admins

                curl "/organization/123/admins" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/admins',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/admins

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}/annual_selected_criteria_plans

get /organization/{organization_id}/annual_selected_criteria_plans

                curl "/organization/{organization_id}/annual_selected_criteria_plans" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/{organization_id}/annual_selected_criteria_plans',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/annual_selected_criteria_plans

TAGS

/organization/{organization_id}/plan

get /organization/{organization_id}/plan

                curl "/organization/{organization_id}/plan" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/{organization_id}/plan',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/plan

TAGS

/organization/{organization_id}/criteria

get /organization/123/criteria

                curl "/organization/123/criteria" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/criteria',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/criteria

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}/events

get /organization/123/events

                curl "/organization/123/events" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/events',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/events

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}/annual_plan

get /organization/{organization_id}/annual_plan

                curl "/organization/{organization_id}/annual_plan" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/{organization_id}/annual_plan',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/annual_plan

TAGS

/organization/{organization_id}/practices

get /organization/123/practices

                curl "/organization/123/practices" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/practices',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/practices

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}/practiceadmins

get /organization/123/practiceadmins

                curl "/organization/123/practiceadmins" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/practiceadmins',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/practiceadmins

TAGS

Query String

Key	Type	Description	Allowed Values
practice_id	number

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/organization/{organization_id}/regions

get /organization/123/regions

                curl "/organization/123/regions" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/regions',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/regions

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/practice/{practice_id}/details

get /practice/123/details

                curl "/practice/123/details" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/practice/123/details',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /practice/{practice_id}/details

TAGS

URI Components

Key	Type	Description	Allowed Values
practice_id	number

/practice/{practice_id}/concept_metrics

get /practice/123/concept_metrics

                curl "/practice/123/concept_metrics" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/practice/123/concept_metrics',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /practice/{practice_id}/concept_metrics

TAGS

URI Components

Key	Type	Description	Allowed Values
practice_id	number

/practice/{practice_id}/criteria

get /practice/123/criteria

                curl "/practice/123/criteria" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/practice/123/criteria',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /practice/{practice_id}/criteria

TAGS

URI Components

Key	Type	Description	Allowed Values
practice_id	number

/practice/{practice_id}/events

get /practice/123/events

                curl "/practice/123/events" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/practice/123/events',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

List the events for a practice

HTTP REQUEST

get /practice/{practice_id}/events

TAGS

• list
• practice
• events

URI Components

Key	Type	Description	Allowed Values
practice_id	number

/user/auth/check

get /user/auth/check

                curl "/user/auth/check" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/user/auth/check',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /user/auth/check

TAGS

/organization/{organization_id}/criteria/annual

get /organization/123/criteria/annual

                curl "/organization/123/criteria/annual" \
                
              

  
  var request = require('request');

  var options = {
    method: 'get',
    path: '/organization/123/criteria/annual',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

get /organization/{organization_id}/criteria/annual

TAGS

URI Components

Key	Type	Description	Allowed Values
organization_id	number

/activity

post /activity

                curl "/activity" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/activity',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /activity

TAGS

/comment

post /comment

                curl "/comment" \
                    -H "Content-Type: application/json" \
                    -d '{
	"user_email": "qux",
	"criterion_id": 123,
	"body": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/comment',
    json: true,
    body: '{
	"user_email": "qux",
	"criterion_id": 123,
	"body": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /comment

TAGS

JSON Payload

Key	Type	Description	Allowed Values
user_email	string
criterion_id	number
body	string

/events

post /events

                curl "/events" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/events',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /events

TAGS

/file

post /file

                curl "/file" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/file',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /file

TAGS

/file

delete /file

                curl "/file" \
                
              

  
  var request = require('request');

  var options = {
    method: 'delete',
    path: '/file',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

delete /file

TAGS

/organization

post /organization

                curl "/organization" \
                    -H "Content-Type: application/json" \
                    -d '{
	"name": "qux",
	"abbreviation": "qux",
	"start_date": "2024-10-04T19:39:33.037Z",
	"end_date": "2024-10-04T19:39:33.037Z",
	"template": {
		"created_at": "2024-10-04T19:39:33.037Z",
		"id": 123,
		"label": "qux",
		"name": "qux",
		"type": "qux",
		"updated_at": "2024-10-04T19:39:33.037Z",
		"version": "qux",
		"value": [
			"foo",
			"bar",
			"baz"
		],
		"variant": "qux",
		"year": 123
	},
	"use_nys": true
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/organization',
    json: true,
    body: '{
	"name": "qux",
	"abbreviation": "qux",
	"start_date": "2024-10-04T19:39:33.037Z",
	"end_date": "2024-10-04T19:39:33.037Z",
	"template": {
		"created_at": "2024-10-04T19:39:33.037Z",
		"id": 123,
		"label": "qux",
		"name": "qux",
		"type": "qux",
		"updated_at": "2024-10-04T19:39:33.037Z",
		"version": "qux",
		"value": [
			"foo",
			"bar",
			"baz"
		],
		"variant": "qux",
		"year": 123
	},
	"use_nys": true
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /organization

TAGS

JSON Payload

Key	Type	Description	Allowed Values
name	string
abbreviation	string
start_date	date
end_date	date
template	object
template.created_at	date
template.id	number
template.label	string
template.name	string
template.type	string
template.updated_at	date
template.version	string
template.value	array
template.variant	string
template.year	number
use_nys	boolean

/practice

post /practice

                curl "/practice" \
                    -H "Content-Type: application/json" \
                    -d '{
	"name": "qux",
	"primary_practice": true,
	"practice_lead": "qux",
	"abbreviation": "qux",
	"region": "qux",
	"organization_id": 123
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/practice',
    json: true,
    body: '{
	"name": "qux",
	"primary_practice": true,
	"practice_lead": "qux",
	"abbreviation": "qux",
	"region": "qux",
	"organization_id": 123
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /practice

TAGS

JSON Payload

Key	Type	Description	Allowed Values
name	string
primary_practice	boolean
practice_lead	string
abbreviation	string
region	string
organization_id	number

/billing/cancelSubscription

post /billing/cancelSubscription

                curl "/billing/cancelSubscription" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/cancelSubscription',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/cancelSubscription

TAGS

/billing/customerStatus

post /billing/customerStatus

                curl "/billing/customerStatus" \
                    -H "Content-Type: application/json" \
                    -d '{
	"email": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/customerStatus',
    json: true,
    body: '{
	"email": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/customerStatus

TAGS

JSON Payload

Key	Type	Description	Allowed Values
email	string

/billing/paymentFailed

post /billing/paymentFailed

                curl "/billing/paymentFailed" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/paymentFailed',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/paymentFailed

TAGS

/billing/purchase

post /billing/purchase

                curl "/billing/purchase" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/purchase',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/purchase

TAGS

/billing/purchaserCheck

post /billing/purchaserCheck

                curl "/billing/purchaserCheck" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/purchaserCheck',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/purchaserCheck

TAGS

/billing/subscriptionCreated

post /billing/subscriptionCreated

                curl "/billing/subscriptionCreated" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/subscriptionCreated',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/subscriptionCreated

TAGS

/billing/updateCard

post /billing/updateCard

                curl "/billing/updateCard" \
                    -H "Content-Type: application/json" \
                    -d '{}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/updateCard',
    json: true,
    body: '{}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/updateCard

TAGS

JSON Payload

Key	Type	Description	Allowed Values
source	object

/billing/updateSubCount

post /billing/updateSubCount

                curl "/billing/updateSubCount" \
                    -H "Content-Type: application/json" \
                    -d '{
	"product": "qux",
	"quantity": 123
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/billing/updateSubCount',
    json: true,
    body: '{
	"product": "qux",
	"quantity": 123
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /billing/updateSubCount

TAGS

JSON Payload

Key	Type	Description	Allowed Values
product	string
quantity	number

/file/generate_upload_link

post /file/generate_upload_link

                curl "/file/generate_upload_link" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/file/generate_upload_link',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /file/generate_upload_link

TAGS

/files/download_all

post /files/download_all

                curl "/files/download_all" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/files/download_all',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /files/download_all

TAGS

/group/purchase

post /group/purchase

                curl "/group/purchase" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/group/purchase',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /group/purchase

TAGS

/user/byemail

post /user/byemail

                curl "/user/byemail" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/byemail',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/byemail

TAGS

/user/getOrgTool

post /user/getOrgTool

                curl "/user/getOrgTool" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/getOrgTool',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/getOrgTool

TAGS

/user/getPracticeTool

post /user/getPracticeTool

                curl "/user/getPracticeTool" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/getPracticeTool',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/getPracticeTool

TAGS

/user/invite

post /user/invite

                curl "/user/invite" \
                    -H "Content-Type: application/json" \
                    -d '{
	"email": "qux",
	"name": "qux",
	"role": "qux",
	"resource": "qux",
	"orgId": "<alternatives>"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/invite',
    json: true,
    body: '{
	"email": "qux",
	"name": "qux",
	"role": "qux",
	"resource": "qux",
	"orgId": "<alternatives>"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/invite

TAGS

JSON Payload

Key	Type	Description	Allowed Values
email	string
name	string
role	string
resource	string
orgId	alternatives

/user/refreshToken

post /user/refreshToken

                curl "/user/refreshToken" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/refreshToken',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/refreshToken

TAGS

/criterion/{criterion_id}/updateEvidence

post /criterion/123/updateEvidence

                curl "/criterion/123/updateEvidence" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/criterion/123/updateEvidence',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /criterion/{criterion_id}/updateEvidence

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number

/criterion/{criterion_id}/comment

post /criterion/{criterion_id}/comment

                curl "/criterion/{criterion_id}/comment" \
                    -H "Content-Type: application/json" \
                    -d '{
	"user_email": "qux",
	"body": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/criterion/{criterion_id}/comment',
    json: true,
    body: '{
	"user_email": "qux",
	"body": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /criterion/{criterion_id}/comment

TAGS

JSON Payload

Key	Type	Description	Allowed Values
user_email	string
body	string

/practice/{practice_id}/update_annual_plan

post /practice/123/update_annual_plan

                curl "/practice/123/update_annual_plan" \
                    -H "Content-Type: application/json" \
                    -d '{
	"concept_code": "qux",
	"selection": true
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/practice/123/update_annual_plan',
    json: true,
    body: '{
	"concept_code": "qux",
	"selection": true
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /practice/{practice_id}/update_annual_plan

TAGS

URI Components

Key	Type	Description	Allowed Values
practice_id	number

JSON Payload

Key	Type	Description	Allowed Values
concept_code	string
selection	boolean

/practice/{practice_id}/update_annual_plan_scope

post /practice/123/update_annual_plan_scope

                curl "/practice/123/update_annual_plan_scope" \
                    -H "Content-Type: application/json" \
                    -d '{
	"concept_code": "qux",
	"scope": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/practice/123/update_annual_plan_scope',
    json: true,
    body: '{
	"concept_code": "qux",
	"scope": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /practice/{practice_id}/update_annual_plan_scope

TAGS

URI Components

Key	Type	Description	Allowed Values
practice_id	number

JSON Payload

Key	Type	Description	Allowed Values
concept_code	string
scope	string

/user/auth/changepassword

post /user/auth/changepassword

                curl "/user/auth/changepassword" \
                    -H "Content-Type: application/json" \
                    -d '{
	"oldpassword": "qux",
	"newpassword": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/auth/changepassword',
    json: true,
    body: '{
	"oldpassword": "qux",
	"newpassword": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/auth/changepassword

TAGS

JSON Payload

Key	Type	Description	Allowed Values
oldpassword	string
newpassword	string

/user/auth/confirmpassword

post /user/auth/confirmpassword

                curl "/user/auth/confirmpassword" \
                    -H "Content-Type: application/json" \
                    -d '{
	"email": "qux",
	"code": "qux",
	"newpassword": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/auth/confirmpassword',
    json: true,
    body: '{
	"email": "qux",
	"code": "qux",
	"newpassword": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/auth/confirmpassword

TAGS

JSON Payload

Key	Type	Description	Allowed Values
email	string
code	string
newpassword	string

/user/auth/resetpassword

post /user/auth/resetpassword

                curl "/user/auth/resetpassword" \
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/auth/resetpassword',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/auth/resetpassword

TAGS

/user/auth/signin

post /user/auth/signin

                curl "/user/auth/signin" \
                    -H "Content-Type: application/json" \
                    -d '{
	"email": "qux",
	"password": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/auth/signin',
    json: true,
    body: '{
	"email": "qux",
	"password": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/auth/signin

TAGS

JSON Payload

Key	Type	Description	Allowed Values
email	string
password	string

/user/auth/signout

post /user/auth/signout

                curl "/user/auth/signout" \
                    -H "Content-Type: application/json" \
                    -d '{
	"email": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'post',
    path: '/user/auth/signout',
    json: true,
    body: '{
	"email": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

post /user/auth/signout

TAGS

JSON Payload

Key	Type	Description	Allowed Values
email	string

/criterion/all/{criterion_id}

put /criterion/all/123

                curl "/criterion/all/123" \
                    -H "Content-Type: application/json" \
                    -d '{
	"status": "qux",
	"checkin": 123,
	"planned": true,
	"components": 123
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/criterion/all/123',
    json: true,
    body: '{
	"status": "qux",
	"checkin": 123,
	"planned": true,
	"components": 123
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /criterion/all/{criterion_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number

JSON Payload

Key	Type	Description	Allowed Values
status	string
checkin	number
planned	boolean
components	number
value	object

/criterion/{criterion_id}/comment/{comment_id}

put /criterion/123/comment/123

                curl "/criterion/123/comment/123" \
                    -H "Content-Type: application/json" \
                    -d '{
	"body": "qux"
}'
                
              

  
  var request = require('request');

  var options = {
    method: 'put',
    path: '/criterion/123/comment/123',
    json: true,
    body: '{
	"body": "qux"
}'
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

put /criterion/{criterion_id}/comment/{comment_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number
comment_id	number

JSON Payload

Key	Type	Description	Allowed Values
body	string

/criterion/{criterion_id}/comment/{comment_id}

delete /criterion/123/comment/123

                curl "/criterion/123/comment/123" \
                
              

  
  var request = require('request');

  var options = {
    method: 'delete',
    path: '/criterion/123/comment/123',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

delete /criterion/{criterion_id}/comment/{comment_id}

TAGS

URI Components

Key	Type	Description	Allowed Values
criterion_id	number
comment_id	number

/user/{user_id}/{org_id}

delete /user/{user_id}/{org_id}

                curl "/user/{user_id}/{org_id}" \
                
              

  
  var request = require('request');

  var options = {
    method: 'delete',
    path: '/user/{user_id}/{org_id}',
  };

  request(options, function (error, response, body) {
    console.log(error, body);
  });
  
              

HTTP REQUEST

delete /user/{user_id}/{org_id}

TAGS