Skip to content
CertifyOS API
/
/
Lists all provider survey...

CertifyOS API

Download OpenAPI description
api.json
api.yaml
Overview
Languages
Servers
Mock server
https://docs.certifyos.com/_mock/reference/application/api/
Production
https://ng-api-production.certifyos.com/
Staging (Test Data)
https://ng-api-stg.certifyos.com/

auth-tokens

Operations

credentialing-workflows

Operations

v2/credentialing-workflows

Operations

providers

Operations

v2/provider

Operations

Retrieve signed url of a given supporting-document id.

Request

Retrieves a signed URL for the specified supporting document ID associated with the provider. The signed URL provides secure, temporary access to the document and remains valid for 10 minutes.

Security
BearerAuth
Path
providerIdstringrequired
supportingDocumentIdstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/supporting-documents/{supportingDocumentId}/signed-url' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Signed URL

Bodyapplication/json
string
Response
application/json
"string"

Lists all provider survey responses in an organization

Request

Security
BearerAuth
Path
providerIdstringrequired
Query
offsetnumber>= 0

The starting index for pagination, specifying how many records to skip.

Default 0
limitnumber

The maximum number of records to retrieve in a single request.

Default 10
versionnumber

Version of the desired survey response

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/survey-responses?offset=0&limit=10&version=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Survey responses

Bodyapplication/json
dataobject
countnumber
Response
application/json
{
  "data": {},
  "count": 0
}

Lists all provider email outreaches in an organization

Request

Security
BearerAuth
Path
providerIdstringrequired
Query
offsetnumber>= 0

The starting index for pagination, specifying how many records to skip.

Default 0
limitnumber

The maximum number of records to retrieve in a single request.

Default 10
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/outreaches?offset=0&limit=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of provider email outreaches

Bodyapplication/json
dataArray of objects(ProviderOutreachDto)required
provider_idstringrequired
organization_idstringrequired
workflow_idstringrequired
outreach_correspondence_idstring
dataobject(OutreachDataDto)required
toArray of stringsrequired
Example: ["string@string.com"]
reasonstringrequired
subjectstringrequired
bodystringrequired
entityTypestring
entityIdstring
numberOfAttachmentsnumber
attachmentsArray of objects(Attachment)
created_atstringrequired
created_by_namestringrequired
idstringrequired
latest_eventstring
outreach_correspondencestring
status_codenumber
sg_message_idstring
countnumberrequired
Example: 10
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 10
}

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations