☰

Author: admin

Getting Started

In basic terms, APIs just allow applications to communicate with one another. API stands for “application programming interface.” The API…

Environments

The environment for your API endpoint depends upon your account’s data center. Please go through the following table to check…

Error Codes

HTTP Status Code Message 400 Bad Request Invalid schema in the body provided. 400 Bad Request Invalid URL parameters 401…

Create a new Folder

POST: https://{env}-api.xebo.ai/v3/survey-management/surveys/folders Headers Content-Type: application/json Authorization type: Bearer type token: <access token> granted from login API Or x-api-key: <api key…

Get all folders

GET: https://{env}-api.xebo.ai/v3/survey-management/surveys/folders Headers Authorization: type: Bearertype token: <access token> granted from login API Or x-api-key: <apikeycopiedfromtheplatform> Content-Type: application/json Request SamplecURL…

Update a folder

PATCH: https://{env}-api.xebo.ai/v3/survey-management/surveys/folders/{folder_id} Headers Authorization: type: Bearer type token: <access token> granted from login API Or x-api-key: <api key copied from…

Delete a Folder

DELETE : https://{env}-api.xebo.ai/v3/survey-management/surveys/folders/{folder_id} Query Params:  Key  Type  Mandatory  Description  transferFolderId  string  no  Folder id where you want to transfer your…

Get Oauth Token from Credentials

POST: https://api.xebo.ai/api/v1/oauth/token Headers "Content-Type": "application/json" Request BodyPayload { "email": "john@xebo.ai", "password": "Survey@123" } Field Type Mandatory Description email string Yes…

Get Oauth Token from Refresh token

POST: https://survey2connect.com/v2/api/oauth/token/refresh Headers "Content-Type": "application/json" Request BodyPayload { "refresh_token": "eyJraWQiOiJzM3E1OWF2cFdIcXVKa0I0MjRpcFpqQVN0dXAzQzFkZEhVM3k2TjNZSXRjPSIsImFs" } Request SamplecURL curl --location --request POST 'https://survey2connect.com/v2/api/oauth/token/refresh' \ --header…

Get Ticket Details

Get: https://{{env}}-api.xebo.ai/v3/api/tickets/{{ticket_id}} The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Get Survey

GET: https://{{env}}.survey2connect.com/v2/api/surveys/{{survey_id}} The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Add Question

POST: https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id}/blocks/{block_id}/questions The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Update Question

PATCH : https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id}/blocks/{block_id}/questions/{ques_id} The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more…

Get all questions

GET : https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id}/all-questions The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more…

Delete Question

DELETE: https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id}/blocks/{block_id}/questions/{ques_id} The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Get API Key

Step 1: Login to the portal Step 2: Logging ➜ User Details ➜ My Account ➜ API Key

Question Type Codes

Following are the question type codes which are used for available question types: Question Type Question code used in JSON…

Create Survey

POST: https://{env}-api.xebo.ai/v3/survey-management/surveys Query Params:  Key  Type  Mandatory  Description  folderId  string  no  Folder id where you want to create your survey …

Fetch all Surveys

PUT: https://{env}-api.xebo.ai/v3/survey-management/surveys/global Key  Type  Mandatory  Description  skip  string  no  Gives the skip value, by default it is 0  limit  string …

Update a Survey

PATCH : https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id} Headers Authorization: type: Bearer type token: <access token> granted from login API Or x-api-key: <api key copied…

Delete a survey

DELETE : https://{env}-api.xebo.ai/v3/survey-management/surveys Query Params: Key Type Mandatory Description folderId string no Folder id in which survey exists Headers Authorization:…

Add/Split Block

POST: https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id}/blocks/{block_id} The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Update a Block

PATCH : https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id}/blocks/{block_id} The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more…

Delete Block

DELETE : https://{env}-api.xebo.ai/v3/survey-management/surveys/{survey_id}/blocks/{block_id} The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more…

Send Surveys

POST: https://{env}-api.xebo.ai/v2/api/collectors/{collector_id}/combined/auto The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Export Survey Links

POST: https://{{env}}-api.xebo.ai/v2/api/collectors/{{collect_id}}/campaigns/external The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Get Responses (JSON Format)

POST: https://{{env}}-api.xebo.ai/api/v1/export/responses/json The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Create Response

POST: https://{{env}}-feedback-api.xebo.ai/v3/survey-participation/{{survey_id}}/response/create-response The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Ask a human

Can't Find What You're Looking For?