{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"606cdf54-deec-474b-818c-b69a6084ed59","name":"Go REST API","description":"The following documentation details the usage of Go REST APIs to manage users, posts, comments, and todos.\n\nGo REST API enables users to:\n\n- `GET` (list of existing users, posts, comments, and todos)\n- `POST` (add a new user, post, comment, and todo),\n- `PUT` (update an existing user, post, comment, and todo)\n- `DELETE` an existing user, post, comment, and todo.\n    \n\n---\n\n# **Getting started**\n\nTo start using the Go REST APIs:\n\n- Create an account in the [Go R](https://gorest.co.in/)[EST](https://gorest.co.in/) application\n- Use a valid Bearer Token to send requests to the API endpoints. Get the Bearer Token from [Access Tokens](https://gorest.co.in/my-account/access-tokens).\n- The API has rate and usage limits.\n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.\n- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n    \n\n# Authentication\n\nThe Go REST API uses Access Key Bearer Token for authentication. Generate a Go REST API key in the [Access Tokens](https://gorest.co.in/my-account/access-tokens) section of the Go Rest account settings.\n\nYou must include the Bearer Token in each request to the Go REST API except for the `GET` method.\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n## Rate and usage limits\n\n### 503 response\n\nAn HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://gorest.co.in/qa).\n\n### **Need some help?**\n\nCheck out the Go Rest community [forum](https://gorest.co.in/qa); there is a good chance the community has an answer for you.\n\n# Parameters\n\n#### Endpoint: `users`\n\n| Parameter name | Value type | **Required/Optional** | Description |\n| --- | --- | --- | --- |\n| id | integer | Required | The parameter is a unique user id. It is machine-generated. |\n| name | string | Required | The parameter is the name of the user. It is user-defined. |\n| email | string | Required | The parameter is the unique email of the user. It is user-defined. |\n| gender | string | Required | The parameter is the gender of the user. Accepted values are `male` and `female`. |\n| status | string | Required | The parameter is the status of the user. Accepted values are `active` and `inactive`. |\n\n#### Endpoint: `posts`\n\n| **Parameter name** | **Value type** | **Required/Optional** | **Description** |\n| --- | --- | --- | --- |\n| id | integer | Required | The parameter is the unique id of the post. It is machine-generated. |\n| user_id | integer | Required | The parameter is the unique id of the user owning the post. It is machine-generated. |\n| title | string | Required | The parameter is the tiltle of the post. It is user-defined. |\n| body | string | Required | The parameter is the body of the post. It is user-defined. |\n\n#### Endpoint: `comments`\n\n| Parameter name | Value type | **Required/Optional** | Description |\n| --- | --- | --- | --- |\n| id | integer | Required | The parameter is the unique id of the comment generated; it is machine-generated. |\n| post_id | integer | Required | The parameter is a unique post id of the comment; it is machine-generated. |\n| name | string | Required | The parameter is the name of the user owning the comment; it is user-defined. |\n| email | string | Required | The parameter is the unique email of the user owning the comment. It is user-defined. |\n| body | string | Required | The parameter is the body of the post. It is user-defined. |\n\n#### Endpoint: `todos`\n\n| **Parameter name** | **Value type** | **Required/Optional** | **Description** |\n| --- | --- | --- | --- |\n| id | integer | Required | The parameter is a unique id of a todo; it is machine-generated. |\n| user_id | integer | Required | The parameter is a unique id for each user; it is machine-generated. |\n| title | string | Required | The parameter is the title of a todo; it is user-defined. |\n| due_on | date | Required | The parameter is the due date of a todo. It is user-defined. |\n| status | string | Required | The parameter is the status of a todo. It is user-defined.  <br>Accepted values: `pending` and `completed`. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11461909","collectionId":"606cdf54-deec-474b-818c-b69a6084ed59","publishedId":"2s93eX2ZA4","public":true,"publicUrl":"https://documenter-api.postman.tech/view/11461909/2s93eX2ZA4","privateUrl":"https://go.postman.co/documentation/11461909-606cdf54-deec-474b-818c-b69a6084ed59","customColor":{"top-bar":"FFFFFF","right-sidebar":"2F2F30","highlight":"409C8C"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/73f44a00-ad07-4666-b266-b8735fc87690/Q2FwdHVyZS5QTkc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"B2DED6"}},{"name":"light","logo":"https://content.pstmn.io/b531e904-f171-4b1b-91ea-a487c3a47f4f/Q2FwdHVyZS5QTkc=","colors":{"top-bar":"FFFFFF","right-sidebar":"2F2F30","highlight":"409C8C"}}]}},"version":"8.12.7","publishDate":"2023-05-07T18:42:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/b531e904-f171-4b1b-91ea-a487c3a47f4f/Q2FwdHVyZS5QTkc=","logoDark":"https://content.pstmn.io/73f44a00-ad07-4666-b266-b8735fc87690/Q2FwdHVyZS5QTkc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s93eX2ZA4"}