Get /organizations/{{organization-id}}/departments/{{department-id}}

Example Request

https://{{env}}.questionpro.com/a/api/v2/organizations/{{organization-id}}/departments/{{department-id}}?apiKey={apiKey}

The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.

Authorization

arrow_rightKey - apiKey
  • Name: apiKey
  • Location: query

Request Parameters

arrow_rightPath Parameters
organization-id integer
required
department-id integer
required

Example Code

arrow_rightcURL
application/json

            curl --request GET \
                 --url 'https://{{env}}.questionpro.com/a/api/v2/organizations/{{organiation-id}}/departments/{{department-id}}?apiKey={{apiKey}}'
        
arrow_rightPython
application/json

                import requests

                url = "https://{{env}}.questionpro.com/a/api/v2/organizations/{{organiation-id}}/departments/{{department-id}}"
            
                querystring = {"apiKey":"{{apiKey}}"}
            
                response = requests.request("GET", url, params=querystring)
            
                print(response.text)  
            
arrow_rightPHP
application/json

            <?php
                    $curl = curl_init();

                    curl_setopt_array($curl, array(
                    CURLOPT_URL =>"https://{{env}}.questionpro.com/a/api/v2/organizations/{{organization-id}}/departments/{{department-id}}?apiKey={{apiKey}}",
                    CURLOPT_RETURNTRANSFER => true,
                    CURLOPT_ENCODING => "",
                    CURLOPT_MAXREDIRS => 10,
                    CURLOPT_TIMEOUT => 30,
                    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                    CURLOPT_CUSTOMREQUEST => "GET",
                    ));
                
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                
                    curl_close($curl);
                
                    if ($err) {
                    echo "cURL Error # :" . $err;
                    } else {
                    echo $response;
                    }
                    ?>
            

Responses

arrow_rightExample
application/json

                        {
                            "response":
                                {
                                    "departmentID": 1111,
                                    "organizationID": 1234567,
                                    "name": "Department 1",
                                    "primaryAccountID": 1234567,
                                    "userCount": 3,
                                    "dashboardUserCount": 0,
                                    "usage": {
                                        "survey": {
                                            "surveysCount": 20,
                                            "totalResponses": 1250,
                                            "devices": 3,
                                            "emailLists": 3,
                                            "emailSent": 5000
                                        },
                                        "storage": {
                                            "uploadedFiles": 0,
                                            "totalSpaceUsed": 0
                                        },
                                        "communities": {
                                            "communitiesCount": 0,
                                            "communityMembers": 0,
                                            "emailsSent": 0
                                        },
                                        "workforce": {
                                            "workforceCount": 0,
                                            "emailsSent": 0
                                        }
                                    }
                                }
                        }
                    
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "organizationID": {
          "type": "integer"
        },
        "dashboardUserCount": {
          "type": "integer"
        },
        "userCount": {
          "type": "integer"
        },
        "departmentID": {
          "type": "integer"
        },
        "primaryAccountID": {
          "type": "integer"
        },
        "usage": {
          "type": "object",
          "properties": {
            "survey": {
              "type": "object",
              "properties": {
                "emailLists": {
                  "type": "integer"
                },
                "totalResponses": {
                  "type": "integer"
                },
                "devices": {
                  "type": "integer"
                },
                "emailSent": {
                  "type": "integer"
                },
                "surveysCount": {
                  "type": "integer"
                }
              },
              "additionalProperties": false,
              "required": [
                "emailLists",
                "totalResponses",
                "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"
          ]
        },
        "name": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "organizationID",
        "dashboardUserCount",
        "userCount",
        "departmentID",
        "primaryAccountID",
        "usage",
        "name"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right400 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "BAD_REQUEST",
         "httpStatusCode": 400,
         "id" : "1000",
         "message": "Invalid URL parameters",
         "resourceUrl":"resource_url"
        }
    }
}
                                
arrow_rightSchema
application/json

{
  "$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"
  ]
}
                                
arrow_right401 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "UNAUTHORIZED",
         "httpStatusCode": 401,
         "id" : "1010",
         "message": "Incorrect API Key",
         "resourceUrl":"resource_url"
        }
    }
}
						
							
arrow_rightSchema
application/json

{
  "$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"
  ]
}
                                
arrow_right403 example
application/json

{
    "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"
        }
    }
}				
							
arrow_rightSchema
application/json

{
  "$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"
  ]
}
                                
arrow_right404 example
application/json

{
    "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"
        }
    }
}
							
							
arrow_rightSchema
application/json

{
  "$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"
  ]
}
                                
arrow_right500 example
application/json

{
    "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"
        }
    }
}
							
arrow_rightSchema
application/json

{
  "$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"
  ]
}