Skip to main content
GET
/
projects
Projects
curl --request GET \
  --url https://demand.researchdesk.com/projects \
  --header 'Authorization: <api-key>'
{
  "total_projects": 1,
  "page": 1,
  "page_size": 50,
  "projects": [
    {
      "id": "c9cf2545-9474-436e-933c-f6dc2cf8a39b",
      "account_id": "fcb8f022-87fa-42c4-b08a-816a8de9758c",
      "project_manager_id": "44b83408-5091-70ae-5cea-b8045195294d",
      "project_name": "5G Network Adoption and Purchasing Decisions",
      "project_number": "5G-001",
      "session_exclusions": [
        "2",
        "3",
        "4"
      ],
      "business_unit": "27daf638-e54c-4e20-a279-c55bccb6a58d"
    }
  ]
}
Rate limit: 10 requests/second Note: The GET method returns a list of objects, POST and PATCH accept and return a single object
Query String Parameters (GET)
ParameterDescriptionRequiredExample
idsComma delimited value of the Project IDs being retreived.No?ids=1,2,3
project_manager_idsComma delimited value of the Project Manager (User) IDs associated with the Projects being retreived.No?project_manager_ids=1,2,3
pageInteger value of the page being retrievedNo; if omitted, the value defaults to 0.?page=2
page_sizeInteger value dictating the number of objects returned per page.No; if omitted, the value defaults to 50.?page_size=100
Project Object Definition
ParameterRequired for POSTRequired for PATCHDescription
idSystem AssignedYesThe ID of the Project object.
account_idYesNoThe ID of the associated Account object.
project_manager_idYesNoThe ID of the associated Project Manager (User) object.
project_nameYesNoThe name of the Project; there is no uniqueness constraint.
project_numberYesNoClient project identifier; nonfunctional.
session_exclusionsNoNoList of Project IDs of which sessions will not be allowed in the Project.

Authorizations

​
Authorization
string
header
required

Authentication token to be sent directly in the Authorization header (no '' prefix).

Headers

​
Authorization
string

Response

200 - application/json

Projects

​
total_projects
integer
​
page
integer
​
page_size
integer
​
projects
object[]
⌘I