POST api/ApiIntegration/SBApiGetAllProjects

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
StartDate	date	None.
EndDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "startDate": "2026-06-19T19:10:58.0871576+00:00",
  "endDate": "2026-06-19T19:10:58.0871576+00:00"
}

application/xml, text/xml

Sample:

<ApiGetProjectsParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <EndDate>2026-06-19T19:10:58.0871576+00:00</EndDate>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <StartDate>2026-06-19T19:10:58.0871576+00:00</StartDate>
</ApiGetProjectsParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiProjectListResponse

Name	Description	Type	Additional information
ApiResponse		ApiResponse	None.
Projects		Collection of ApiProjectListItem	None.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "fd62f372-edae-4fdd-b24f-88bd215f1e23",
    "responseNote": "sample string 2"
  },
  "projects": [
    {
      "projectUid": "15f44e34-99c4-41c4-a9c0-ad9ced2c2e0e",
      "projectKey": "9dbe8c4a-4dce-49f1-bce2-f47a93577c11",
      "projectName": "sample string 3",
      "jobCount": 4,
      "jobs": [
        {
          "jobUid": "cf4ebf34-1a13-4e14-9765-c61f2be8a414",
          "jobKey": "18360773-915b-4278-a022-4b8a70c9250f",
          "jobName": "sample string 3",
          "jobNumber": "sample string 4",
          "quoteNumber": "sample string 5",
          "createdDate": "2026-06-19T19:10:58.0871576+00:00",
          "updatedDate": "2026-06-19T19:10:58.0871576+00:00",
          "activeScenario": true,
          "scenarios": [
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            },
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            }
          ]
        },
        {
          "jobUid": "cf4ebf34-1a13-4e14-9765-c61f2be8a414",
          "jobKey": "18360773-915b-4278-a022-4b8a70c9250f",
          "jobName": "sample string 3",
          "jobNumber": "sample string 4",
          "quoteNumber": "sample string 5",
          "createdDate": "2026-06-19T19:10:58.0871576+00:00",
          "updatedDate": "2026-06-19T19:10:58.0871576+00:00",
          "activeScenario": true,
          "scenarios": [
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            },
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            }
          ]
        }
      ]
    },
    {
      "projectUid": "15f44e34-99c4-41c4-a9c0-ad9ced2c2e0e",
      "projectKey": "9dbe8c4a-4dce-49f1-bce2-f47a93577c11",
      "projectName": "sample string 3",
      "jobCount": 4,
      "jobs": [
        {
          "jobUid": "cf4ebf34-1a13-4e14-9765-c61f2be8a414",
          "jobKey": "18360773-915b-4278-a022-4b8a70c9250f",
          "jobName": "sample string 3",
          "jobNumber": "sample string 4",
          "quoteNumber": "sample string 5",
          "createdDate": "2026-06-19T19:10:58.0871576+00:00",
          "updatedDate": "2026-06-19T19:10:58.0871576+00:00",
          "activeScenario": true,
          "scenarios": [
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            },
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            }
          ]
        },
        {
          "jobUid": "cf4ebf34-1a13-4e14-9765-c61f2be8a414",
          "jobKey": "18360773-915b-4278-a022-4b8a70c9250f",
          "jobName": "sample string 3",
          "jobNumber": "sample string 4",
          "quoteNumber": "sample string 5",
          "createdDate": "2026-06-19T19:10:58.0871576+00:00",
          "updatedDate": "2026-06-19T19:10:58.0871576+00:00",
          "activeScenario": true,
          "scenarios": [
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            },
            {
              "scenarioUid": "e6d1f718-05e6-4002-9acc-ecca735c17bc",
              "scenarioKey": "15d85931-378e-408c-875e-28136c56aa8e",
              "scenarioName": "sample string 3",
              "jobName": "sample string 4",
              "createdDate": "2026-06-19T19:10:58.0871576+00:00",
              "updatedDate": "2026-06-19T19:10:58.0871576+00:00"
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ApiProjectListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>fd62f372-edae-4fdd-b24f-88bd215f1e23</ReturnKey>
  </ApiResponse>
  <Projects>
    <ApiProjectListItem>
      <JobCount>4</JobCount>
      <Jobs>
        <ApiJobListItem>
          <ActiveScenario>true</ActiveScenario>
          <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
          <JobKey>18360773-915b-4278-a022-4b8a70c9250f</JobKey>
          <JobName>sample string 3</JobName>
          <JobNumber>sample string 4</JobNumber>
          <JobUid>cf4ebf34-1a13-4e14-9765-c61f2be8a414</JobUid>
          <QuoteNumber>sample string 5</QuoteNumber>
          <Scenarios>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
          </Scenarios>
          <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
        </ApiJobListItem>
        <ApiJobListItem>
          <ActiveScenario>true</ActiveScenario>
          <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
          <JobKey>18360773-915b-4278-a022-4b8a70c9250f</JobKey>
          <JobName>sample string 3</JobName>
          <JobNumber>sample string 4</JobNumber>
          <JobUid>cf4ebf34-1a13-4e14-9765-c61f2be8a414</JobUid>
          <QuoteNumber>sample string 5</QuoteNumber>
          <Scenarios>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
          </Scenarios>
          <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
        </ApiJobListItem>
      </Jobs>
      <ProjectKey>9dbe8c4a-4dce-49f1-bce2-f47a93577c11</ProjectKey>
      <ProjectName>sample string 3</ProjectName>
      <ProjectUid>15f44e34-99c4-41c4-a9c0-ad9ced2c2e0e</ProjectUid>
    </ApiProjectListItem>
    <ApiProjectListItem>
      <JobCount>4</JobCount>
      <Jobs>
        <ApiJobListItem>
          <ActiveScenario>true</ActiveScenario>
          <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
          <JobKey>18360773-915b-4278-a022-4b8a70c9250f</JobKey>
          <JobName>sample string 3</JobName>
          <JobNumber>sample string 4</JobNumber>
          <JobUid>cf4ebf34-1a13-4e14-9765-c61f2be8a414</JobUid>
          <QuoteNumber>sample string 5</QuoteNumber>
          <Scenarios>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
          </Scenarios>
          <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
        </ApiJobListItem>
        <ApiJobListItem>
          <ActiveScenario>true</ActiveScenario>
          <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
          <JobKey>18360773-915b-4278-a022-4b8a70c9250f</JobKey>
          <JobName>sample string 3</JobName>
          <JobNumber>sample string 4</JobNumber>
          <JobUid>cf4ebf34-1a13-4e14-9765-c61f2be8a414</JobUid>
          <QuoteNumber>sample string 5</QuoteNumber>
          <Scenarios>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
            <ApiScenarioListItem>
              <CreatedDate>2026-06-19T19:10:58.0871576+00:00</CreatedDate>
              <JobName>sample string 4</JobName>
              <ScenarioKey>15d85931-378e-408c-875e-28136c56aa8e</ScenarioKey>
              <ScenarioName>sample string 3</ScenarioName>
              <ScenarioUid>e6d1f718-05e6-4002-9acc-ecca735c17bc</ScenarioUid>
              <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
            </ApiScenarioListItem>
          </Scenarios>
          <UpdatedDate>2026-06-19T19:10:58.0871576+00:00</UpdatedDate>
        </ApiJobListItem>
      </Jobs>
      <ProjectKey>9dbe8c4a-4dce-49f1-bce2-f47a93577c11</ProjectKey>
      <ProjectName>sample string 3</ProjectName>
      <ProjectUid>15f44e34-99c4-41c4-a9c0-ad9ced2c2e0e</ProjectUid>
    </ApiProjectListItem>
  </Projects>
</ApiProjectListResponse>