Skip to content

Add content-type JSON header section #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2019
Merged

Add content-type JSON header section #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You can also submit a feature request [here](https://portal.productboard.com/zen

- [Root Endpoint](#root-endpoint)
- [Authentication](#authentication)
- [Content-Type: JSON](#content-type-json)
- [API Rate Limit](#api-rate-limit)
- [Errors](#errors)

Expand Down Expand Up @@ -71,6 +72,15 @@ Alternatively, you can choose to send the token in the URL using the `access_tok
- Each user may only have one token, so generating a new token will invalidate previously created tokens.
- For ZenHub Enterprise users, please follow the instructions in `https://<zenhub_enterprise_host>/setup/howto/api`

## Content-Type: JSON

Our REST API only supports JSON content for requests with a body and for responses.
For each request containing a body with JSON, you will need to attach the header `'Content-Type: application/json'` with your request. For example, using `curl` it’d be:

```sh
curl -H 'Content-Type: application/json' URL
```

## API Rate Limit

We allow a maximum of 100 requests per minute to our API. All requests responses include the following headers related to this limitation.
Expand Down