Hotline API

Get Schema

GET /request-schemas/{schemaid}
Bearer auth

Get request schema

Path parameters

  • schemaid string Required

    Unique identifier of the request schema

    Minimum length is 32, maximum length is 32. Format should match the following pattern: S[A-Z0-9]+.

Responses

  • 200 application/json

    Get request schema

    Hide response attributes Show response attributes object
    • title string

      Schema title

      Minimum length is 1, maximum length is 256. Format should match the following pattern: [a-zA-Z0-9_\- ]+.

    • files array[object]
      Hide files attributes Show files attributes object
    • updatedAt string(date-time) Required

      https://datatracker.ietf.org/doc/html/rfc3339#section-5.6 - RFC3339 date-time in UTC

      Minimum length is 20, maximum length is 20.
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
  • 401 application/json

    Unauthorized request

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
  • 404 application/json

    Resource not found

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
  • 429 application/json

    Too many requests

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • code string(string) Required

      Error code

      Minimum length is 1, maximum length is 64.

    • message string(string) Required

      Human-readable error message

      Minimum length is 1, maximum length is 1024.
GET /request-schemas/{schemaid} 
curl \
 --request GET '/api/v1/request-schemas/S7AB56CD456OP98BN54CAUB43211OU78' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "title": "Request schema",
  "files": [
    {
      "name": "request-headers.json",
      "updatedAt": "2017-07-21T17:32:28Z"
    }
  ],
  "updatedAt": "2017-07-21T17:32:28Z"
}
Response examples (400) 
{
  "code": "string",
  "message": "string"
}
Response examples (401) 
{
  "code": "string",
  "message": "string"
}
Response examples (404) 
{
  "code": "string",
  "message": "string"
}
Response examples (429) 
{
  "code": "string",
  "message": "string"
}
Response examples (500) 
{
  "code": "string",
  "message": "string"
}