Response Format Guide

Welcome to the response format guide! This page will provide you with all the necessary information to understand the different formats in which our API responses are provided.

Common Response Formats

Our API supports several response formats, which can be specified in the Accept header of your request. Here are the most common formats:

JSON: The default format. It is widely used and easily parsed by most programming languages.
XML: Suitable for systems that prefer XML-based data.
CSV: Ideal for tabular data that can be easily imported into spreadsheet software.

Choosing the Right Format

When making a request to our API, you can specify the desired response format using the Accept header. For example:

GET /api/resource?param=value HTTP/1.1
Host: example.com
Accept: application/json

This request will return a JSON response.

Example Response

Here is an example of a JSON response from our API:

{
  "data": {
    "id": 123,
    "name": "Example Resource",
    "description": "This is an example resource."
  },
  "status": "success"
}

Learn More

If you want to dive deeper into the different response formats and how to work with them, we recommend checking out our API Reference section.