API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/organizations/{{organization-id}}
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
curl --location 'https://api.questionpro.{{env}}/a/api/v2/organizations/{{organization-id}}' \
--header 'api-key: {{api-key}}'
import requests
url = "https://api.questionpro.{{env}}/a/api/v2/organizations/{{organization-id}}"
payload = {}
headers = {
'api-key': '{{api-key}}'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/organizations/{{organization-id}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: {{api-key}}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"response": {
"accountRepEmail": "[email protected]",
"dashboardUserCount": 0,
"license": "License Name",
"name": "Organization Name",
"organizationID": 1234567,
"primaryAccountID": 1234567,
"primaryAccountUsername": "[email protected]",
"shortUrl": "emaildomain.questionpro.com",
"smtpRelay": "",
"styleSheet": "",
"usage": {
"communities": {
"communitiesCount": 10,
"communityMembers": 140,
"emailsSent": 500
},
"storage": {
"totalSpaceUsed": 56912652,
"uploadedFiles": 117
},
"survey": {
"completedResponses": 13393,
"devices": 3,
"emailLists": 113,
"emailSent": 353,
"surveysCount": 275,
"totalResponses": 23420
},
"workforce": {
"emailsSent": 20,
"workforceCount": 2
}
},
"userCount": 22,
"welcomeHTML": ""
},
"requestID": "4012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"dashboardUserCount": {
"type": "integer"
},
"styleSheet": {
"type": "string"
},
"shortUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"survey": {
"type": "object",
"properties": {
"emailLists": {
"type": "integer"
},
"totalResponses": {
"type": "integer"
},
"completedResponses": {
"type": "integer"
},
"devices": {
"type": "integer"
},
"emailSent": {
"type": "integer"
},
"surveysCount": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"emailLists",
"totalResponses",
"completedResponses",
"devices",
"emailSent",
"surveysCount"
]
},
"workforce": {
"type": "object",
"properties": {
"workforceCount": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"workforceCount",
"emailsSent"
]
},
"storage": {
"type": "object",
"properties": {
"uploadedFiles": {
"type": "integer"
},
"totalSpaceUsed": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"uploadedFiles",
"totalSpaceUsed"
]
},
"communities": {
"type": "object",
"properties": {
"communityMembers": {
"type": "integer"
},
"communitiesCount": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"communityMembers",
"communitiesCount",
"emailsSent"
]
}
},
"additionalProperties": false,
"required": [
"survey",
"workforce",
"storage",
"communities"
]
},
"accountRepEmail": {
"type": "string",
"format": "email"
},
"welcomeHTML": {
"type": "string"
},
"organizationID": {
"type": "integer"
},
"license": {
"type": "string"
},
"primaryAccountUsername": {
"type": "string",
"format": "email"
},
"userCount": {
"type": "integer"
},
"primaryAccountID": {
"type": "integer"
},
"name": {
"type": "string"
},
"smtpRelay": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"dashboardUserCount",
"styleSheet",
"shortUrl",
"usage",
"accountRepEmail",
"welcomeHTML",
"organizationID",
"license",
"primaryAccountUsername",
"userCount",
"primaryAccountID",
"name",
"smtpRelay"
]
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"response",
"requestID"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "BAD_REQUEST",
"httpStatusCode": 400,
"id" : "1000",
"message": "Invalid URL parameters",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "UNAUTHORIZED",
"httpStatusCode": 401,
"id" : "1010",
"message": "Incorrect API Key",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "FORBIDDEN",
"httpStatusCode": 403,
"id" : "1013",
"message": "The user does not have permission to access the resource",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "NOT_FOUND",
"httpStatusCode": 404,
"id" : "1040",
"message": "The resource that you're trying to access doesn't exist",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "INTERNAL_SERVER_ERROR",
"httpStatusCode": 500,
"id" : "1026",
"message": "We are not able to process your request",
"resourceUrl":"resource_url"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"docs": {
"type": "string"
},
"resourceUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"httpStatusCode": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"docs",
"resourceUrl",
"name",
"id",
"message",
"httpStatusCode"
]
}
},
"additionalProperties": false,
"required": [
"error"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}