Questions

Questions Documentation

Question [LIST]

Question [LIST]

Request

Endpoint

GET /api/v2/coaching/questions
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

position

Type Unknown

Description Sort by position

Required No

Filters

organization_id

Type ID string

Description Filter by Organization; accepts an Organization id

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "b906fd06-2069-461e-95f6-eae08784a7af",
      "type": "coaching_questions",
      "attributes": {
        "created_at": "2022-01-12T17:18:54Z",
        "position": 0,
        "prompt": "This is a question",
        "required": false,
        "response_options": null,
        "updated_at": "2022-01-12T17:18:54Z",
        "updated_in_db_at": "2022-01-12T17:18:54Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "837ac588-b8c4-469f-b9ce-9130f081cb34",
            "type": "organizations"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Question]

Description An array of Question Objects

Question [GET]

Question [GET]

Request

Endpoint

GET /api/v2/coaching/questions/7bcf5a87-deef-483d-aa3e-62628f494acc
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "7bcf5a87-deef-483d-aa3e-62628f494acc",
    "type": "coaching_questions",
    "attributes": {
      "created_at": "2022-01-12T17:18:54Z",
      "position": 0,
      "prompt": "This is a question",
      "required": false,
      "response_options": null,
      "updated_at": "2022-01-12T17:18:54Z",
      "updated_in_db_at": "2022-01-12T17:18:54Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "fe836edb-c73f-4e00-860e-b1f08803d9b3",
          "type": "organizations"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

position

Type integer

Description What order the question should be in

prompt

Type string

Description The question itself

required

Type boolean

Description Is this question required

response_options

Type ["string"]

Description If the question is multiple choice, the list of string options

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

organization.data

Type Organization

Description The Organization that the question belongs to