Get a Q&A

GET

/projects/{projectId}/qnas/{qnaId}

const url = 'https://api.siteassist.io/v2/projects/123e4567-e89b-12d3-a456-426614174000/qnas/e2c6b2ad-9b1f-4f3c-8f5a-9f2a7b1c2d3e';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteassist.io/v2/projects/123e4567-e89b-12d3-a456-426614174000/qnas/e2c6b2ad-9b1f-4f3c-8f5a-9f2a7b1c2d3e

Retrieve a single Q&A entry by ID within the specified project. Returns author info when available.

Parameters

Path Parameters

projectId

required

The project ID that owns the Q&A

string format: uuid

Example

123e4567-e89b-12d3-a456-426614174000

qnaId

required

The Q&A identifier

string format: uuid

Example

e2c6b2ad-9b1f-4f3c-8f5a-9f2a7b1c2d3e

Responses

200

Successfully retrieved Q&A

application/json

The Q&A object containing the question, answer, and author info.

object

object

string

default: qna

Allowed values: qna

required

string format: uuid

createdAt

required

string

updatedAt

required

string

question

required

string

answer

required

string

createdBy

object

name

required

string

nullable

image

required

string

nullable

Example

{
  "object": "qna",
  "id": "e2c6b2ad-9b1f-4f3c-8f5a-9f2a7b1c2d3e",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "question": "How do I reset my password?",
  "answer": "Click on 'Forgot password' at login and follow instructions.",
  "createdBy": {
    "name": "Taylor",
    "image": null
  }
}

400

Bad request

401

Unauthorized

403

Forbidden

404

Requested resource not found.

500

Internal server error