Skip to content

Prospect API (1)

Automates process of creating organizations for new business prospects.

Download OpenAPI description
api-v1.json
api-v1.yaml
Overview
URL

https://www.cdq.com/about-cdq#cdq-team

Krystian Sola

krystian.sola@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/prospect-api/api-v1/

Production SOAP

https://prospect-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/soap/v1/

Production

https://prospect-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/

workflows

Workflows.

Trial Organization Workflow

Operations

Create Trial Organization Workflow

Request

Creates a trial organization workflow for a new business prospect. This endpoint is used to initiate the process of creating an organization, workspace, and other related resources.

Security
oAuth2
Bodyapplication/json
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/prospect-api/api-v1/trialorganizationworkflows \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organizationId": "cdq_monitor"
  }'

Responses

OK

Bodyapplication/json
descriptionstring

Description of the trial organization workflow.

Example: "Prepare Trial Organization"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
stepsArray of objects(WorkflowStep)
Response
application/json
{
  "description": "Prepare Trial Organization",
  "organizationId": "cdq_monitor",
  "steps": [
    { … }
  ]
}

Get Trial Organization Workflow

Request

Retrieves the trial organization workflow for a specific organization. This endpoint is used to check the status and details of the workflow for a given organization.

Security
oAuth2
Path
organizationIdstring(OrganizationId)required

ID of the organization for which the workflow is being retrieved.

Example: cdq_monitor
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/prospect-api/api-v1/trialorganizationworkflows/cdq_monitor \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
descriptionstring

Description of the trial organization workflow.

Example: "Prepare Trial Organization"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
stepsArray of objects(WorkflowStep)
Response
application/json
{
  "description": "Prepare Trial Organization",
  "organizationId": "cdq_monitor",
  "steps": [
    { … }
  ]
}

Get information about available steps in the workflow and their types.

Request

Calling this endpoint will return information about available steps in the workflow and their types.

Security
oAuth2
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/prospect-api/api-v1/trialorganizationworkflows/info \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

ok

Bodyapplication/json
descriptionstring

Description of the trial organization workflow.

Example: "Prepare Trial Organization"
stepsArray of objects(WorkflowInfoStep)
Response
application/json
{
  "description": "Prepare Trial Organization",
  "steps": [
    { … }
  ]
}

LinkedIn

Operations

Maintenance

Operations