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

LinkedIn

Operations

Register LinkedIn-originating Organization

Request

Create organization, workspace without data mirror, lookup configuration and api key with that lookup configuration assigned.

Security
oAuth2
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/prospect-api/api-v1/prospects/linkedin/callback \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Read Registered Organizations

Request

Retrieve list of already registered users via LinkedIn.

Security
oAuth2
Query
organizationIdstring(OrganizationId)

ID of the organization.

Example: organizationId=cdq_monitor
curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/prospect-api/api-v1/prospects/linkedin/registrations?organizationId=cdq_monitor' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
organizationsArray of objects(LinkedInOrganization)
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
Response
application/json
{
  "organizations": [
    { … }
  ],
  "total": "67"
}

Maintenance

Operations