Get account data by ID

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "number"
    }
  },
  "required": [
    "account_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "_embedded": {
      "type": "object",
      "description": "Account object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "address": {
              "type": "object",
              "properties": {
                "address_1": {
                  "type": "string",
                  "description": "Street portion of the address"
                },
                "address_2": {
                  "type": "string",
                  "description": "Additional address information"
                },
                "city": {
                  "type": "string",
                  "description": "City name"
                },
                "country": {
                  "type": "string",
                  "description": "Country code"
                },
                "postal_code": {
                  "type": "string",
                  "description": "Postal code"
                },
                "state": {
                  "type": "string",
                  "description": "State/Province code"
                }
              }
            },
            "id": {
              "type": "number",
              "description": "Unique identifier of the account"
            },
            "name": {
              "type": "string",
              "description": "Name of the account"
            },
            "status": {
              "type": "string",
              "description": "Status of the account"
            }
          }
        }
      }
    },
    "_links": {
      "type": "object",
      "properties": {
        "first": {
          "type": "object",
          "description": "URL to the first page of records",
          "properties": {
            "href": {
              "type": "string"
            }
          }
        },
        "last": {
          "type": "object",
          "description": "URL to the last page of records",
          "properties": {
            "href": {
              "type": "string"
            }
          }
        },
        "next": {
          "type": "object",
          "description": "URL to the next page of records",
          "properties": {
            "href": {
              "type": "string"
            }
          }
        },
        "prev": {
          "type": "object",
          "description": "URL to the previous page of records",
          "properties": {
            "href": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "object",
          "description": "URL to the current page of records",
          "properties": {
            "href": {
              "type": "string"
            }
          }
        }
      }
    },
    "page": {
      "type": "number",
      "description": "Current page number"
    },
    "page_size": {
      "type": "number",
      "description": "Number of records per page"
    },
    "total_items": {
      "type": "number",
      "description": "Total number of records"
    },
    "total_pages": {
      "type": "number",
      "description": "Total number of pages"
    }
  }
}