{ "info": { "_postman_id": "e44a899d-f8d2-4d7e-a1e2-83314a3efbdd", "name": "Method REST API", "description": "# Introduction\r\nThe Method REST API is built on HTTP. Our API is RESTful. It has predictable resource URLs. \r\nIt returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body.\r\nYou can use your favorite HTTP/REST library for your programming language to use Method's Rest API.\r\n\r\n# Getting Started\r\nTODO: Write steps to request an oauth2 client and then steps to get a token. Link to postman collection\r\n\r\n# Authentication\r\n## OAuth2\r\nThe Method REST API uses the OAuth2.0 protocol for authentication. \r\nIt is an industry-standard protocol specification that enables third-party applications (clients) to gain delegated access to protected resources in Method via API.\r\n\r\n### Why should we use OAuth2?\r\n- Clients are not required to support password authentication or store user credentials.\r\n- Clients gain delegated access, i.e., access only to resources authenticated by the user.\r\n- Users can revoke the client's delegated access anytime.\r\n- OAuth2.0 access tokens expire after a set time. If the client faces a security breach, user data will be compromised only until the access token is valid.\r\n\r\n### Terminologies\r\nThe following are some terms you need to know before you start using the Method REST APIs.\r\n\r\n- #### Protected resources\r\n The Method resources, such as Contacts, Activities, Invoice, etc.\r\n\r\n- #### Resource server\r\n Method server that hosts protected resources.\r\n\r\n- #### Resource owner\r\n Any end-user of your account, who can grant access to the protected resources.\r\n\r\n- #### Client\r\n An application that sends requests to the resource server to access the protected resources on behalf of the end-user.\r\n\r\n- #### Client ID\r\n The consumer key generated from the connected application.\r\n\r\n- #### Client Secret\r\n The consumer secret generated from the connected application.\r\n\r\n- #### Authentication server\r\n Authorization server provides the necessary credentials (such as Access and Refresh tokens) to the client. In this case, it will be the Method authorization server.\r\n\r\n- #### Authentication code\r\n The authorization server creates a temporary token and sends it to the client via the browser. The client will send this code to the authorization server to obtain access and refresh tokens.\r\n\r\n- #### Tokens\r\n - ##### Access Token\r\n A token that is sent to the resource server to access the protected resources of the user. The Access token provides secure and temporary access to Method REST APIs and is used by the applications to make requests to the connected app. Each access token will be valid only for an hour and can be used only for the set of operations that are described in the scope.\r\n\r\n - ##### Refresh Token\r\n A token that can be used to obtain new access tokens. This token has an unlimited lifetime until it is revoked by the end-user.\r\n\r\n- #### Scopes\r\n Control the type of resource that the client application can access. \r\nTokens are usually created with various scopes to ensure improved security.\r\nCurrently supported/required scopes are as follows:\r\n - `openid` Required, to request access to user id, token issued at time and token expiry time\r\n - `profile` Optional, to request access to user profile information like name, lastname etc\r\n - `email` Optional, to request access to user's email address information\r\n - `api` Required, to request access to Method REST API\r\n\r\n## API-Key\r\n(Coming Soon)\r\n\r\n# HTTP Request Methods\r\n| Method | Description |\r\n|--------|------------------------------------------|\r\n| GET | To retrieve data/resource from the resource server. |\r\n| POST | To insert or upload any new resource to the server. |\r\n| PUT | To update an existing resource. This replaces the target resource with the updated content. |\r\n| PATCH | To update a specific detail of the resource. This method updates the target resource with the provided content without changing other data. |\r\n| DELETE | To delete a resource at a particular location. |\r\n\r\n# HTTP Status Codes\r\n| Status Codes | Meaning | Description |\r\n|--------------|--------------------------|------------------------------------------|\r\n| 200 | OK | The API request is successful. |\r\n| 201 | CREATED | Resource created. Ex. Contact created. |\r\n| 204 | NO CONTENT | There is no content available for the request. Usually for DELETE, PUT or PATCH methods |\r\n| 400 | BAD REQUEST | The request is invalid. Required fields are missing |\r\n| 401 | AUTHORIZATION ERROR | Invalid API key or Access Token. e.g. Access Token expired |\r\n| 403 | FORBIDDEN | No permission to do the operation. e.g. Token is valid but user does not have necessary permission |\r\n| 404 | NOT FOUND | Invalid request. e.g. Record or Table not found |\r\n| 405 | METHOD NOT ALLOWED | The specified method is not allowed. |\r\n| 413 | REQUEST ENTITY TOO LARGE | The server did not accept the request while uploading a file, since the limited file size has exceeded. |\r\n| 415 | UNSUPPORTED MEDIA TYPE | The server did not accept the request while uploading a file, since the media/ file type is not supported. |\r\n| 429 | TOO MANY REQUESTS | Number of API requests for the time period has exceeded |\r\n| 500 | INTERNAL SERVER ERROR | Generic error that is encountered due to an unexpected server error. |\r\n\r\n# API Limits\r\n(Coming Soon)\n\nContact Support:\n Name: Method Support\n Email: support@method.me", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Files", "item": [ { "name": "Get Linked Files", "event": [ { "listen": "test", "script": { "id": "370972ea-99bb-496c-9984-96a03c99d823", "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{restapi-baseurl}}/api/v1/files?table=Contacts&recordId=2", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "files" ], "query": [ { "key": "table", "value": "Contacts" }, { "key": "recordId", "value": "2" } ] }, "description": "Verifies response for top and skip parameters" }, "response": [ { "name": "Records returned successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Crenshaw\",\n \"phone\": \"111-222-3333\",\n \"email\": \"amy.c@gmail.com\"\n },\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Shaw\",\n \"phone\": \"111-000-1234\",\n \"email\": \"amy_shaw@gmail.com\"\n }\n]" }, { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" } ] }, { "name": "Upload File", "event": [ { "listen": "test", "script": { "id": "e8736824-0b75-420c-9384-3c696372c46b", "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "", "type": "file", "src": "/D:/Desktop/embed.html" }, { "key": "table", "value": "Contacts", "type": "text" }, { "key": "recordId", "value": "2", "type": "text" }, { "key": "attachToEmail", "value": "true", "type": "text" } ] }, "url": { "raw": "{{restapi-baseurl}}/api/v1/files", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "files" ] }, "description": "Verifies response for top and skip parameters" }, "response": [ { "name": "Records returned successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Crenshaw\",\n \"phone\": \"111-222-3333\",\n \"email\": \"amy.c@gmail.com\"\n },\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Shaw\",\n \"phone\": \"111-000-1234\",\n \"email\": \"amy_shaw@gmail.com\"\n }\n]" }, { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" } ] }, { "name": "Update File Link", "event": [ { "listen": "test", "script": { "id": "3b09a20b-d79d-4bc5-9eec-4084bbd8da6f", "exec": [ "// get this from variable", "let baseUrl = pm.environment.get(\"restapi-baseurl\");", "let jsonData = pm.response.json();", "var moment = require('moment');", "", "pm.test(\"File link updated successfully\", function () { ", " pm.response.to.have.status(204); ", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"tableName\": \"Contacts\",\r\n \"recordId\": {{createdRecordId}},\r\n \"attachToEmail\" : false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{restapi-baseurl}}/api/v1/files/80588584-1e5b-4a0e-86b5-3db3f7a1cd1a/link", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "files", "80588584-1e5b-4a0e-86b5-3db3f7a1cd1a", "link" ] }, "description": "Verifies response for top and skip parameters" }, "response": [ { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Records returned successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Crenshaw\",\n \"phone\": \"111-222-3333\",\n \"email\": \"amy.c@gmail.com\"\n },\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Shaw\",\n \"phone\": \"111-000-1234\",\n \"email\": \"amy_shaw@gmail.com\"\n }\n]" } ] }, { "name": "Download File", "event": [ { "listen": "test", "script": { "id": "71a7a7df-d75f-4e55-917a-e249886f5318", "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{restapi-baseurl}}/api/v1/files/80588584-1e5b-4a0e-86b5-3db3f7a1cd1a/download", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "files", "80588584-1e5b-4a0e-86b5-3db3f7a1cd1a", "download" ] }, "description": "Verifies response for top and skip parameters" }, "response": [ { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Records returned successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Crenshaw\",\n \"phone\": \"111-222-3333\",\n \"email\": \"amy.c@gmail.com\"\n },\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Shaw\",\n \"phone\": \"111-000-1234\",\n \"email\": \"amy_shaw@gmail.com\"\n }\n]" } ] }, { "name": "Get File URL", "event": [ { "listen": "test", "script": { "id": "f5d6f065-0f7f-49de-9843-29fe9c8a291d", "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{restapi-baseurl}}/api/v1/files/80588584-1e5b-4a0e-86b5-3db3f7a1cd1a/url", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "files", "80588584-1e5b-4a0e-86b5-3db3f7a1cd1a", "url" ] }, "description": "Verifies response for top and skip parameters" }, "response": [ { "name": "Records returned successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Crenshaw\",\n \"phone\": \"111-222-3333\",\n \"email\": \"amy.c@gmail.com\"\n },\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Shaw\",\n \"phone\": \"111-000-1234\",\n \"email\": \"amy_shaw@gmail.com\"\n }\n]" }, { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" } ] }, { "name": "Delete File", "event": [ { "listen": "test", "script": { "id": "f9544da0-10e3-4d24-808e-3bce710d1821", "exec": [ "// get this from variable", "let baseUrl = pm.environment.get(\"restapi-baseurl\");", "", "", "pm.test(\"Status code 204\", function () {", " pm.response.to.have.status(204);", "});" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [], "url": { "raw": "{{restapi-baseurl}}/api/v1/files/80588584-1e5b-4a0e-86b5-3db3f7a1cd1a", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "files", "80588584-1e5b-4a0e-86b5-3db3f7a1cd1a" ] }, "description": "Verifies response for top and skip parameters" }, "response": [ { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Records returned successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Crenshaw\",\n \"phone\": \"111-222-3333\",\n \"email\": \"amy.c@gmail.com\"\n },\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Shaw\",\n \"phone\": \"111-000-1234\",\n \"email\": \"amy_shaw@gmail.com\"\n }\n]" } ] } ], "protocolProfileBehavior": {} }, { "name": "Tables", "item": [ { "name": "Query Records", "request": { "method": "GET", "header": [], "url": { "raw": "{{restapi-baseurl}}/api/v1/tables/:table?skip=0&top=10&filter=BillAddressCountry eq 'Canada' or BillAddressCountry eq 'USA'&select=RecordID, Email, FirstName, LastName, BillAddressCountry, TotalBalance&orderby=LastModifiedDate desc", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "tables", ":table" ], "query": [ { "key": "skip", "value": "0", "description": "How many matched records to skip before the first return" }, { "key": "top", "value": "10", "description": "Return only this amount of records" }, { "key": "filter", "value": "BillAddressCountry eq 'Canada' or BillAddressCountry eq 'USA'", "description": "Filter using OData specification. e.g. Firstname eq 'Amy'
Details" }, { "key": "select", "value": "RecordID, Email, FirstName, LastName, BillAddressCountry, TotalBalance", "description": "List of fields to be returned in the response" }, { "key": "orderby", "value": "LastModifiedDate desc", "description": "Order by specified fields" } ], "variable": [ { "key": "table", "value": "Customer" } ] } }, "response": [ { "name": "Records returned successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Crenshaw\",\n \"phone\": \"111-222-3333\",\n \"email\": \"amy.c@gmail.com\"\n },\n {\n \"recordId\": 1,\n \"firstName\": \"Amy\",\n \"lastName\": \"Shaw\",\n \"phone\": \"111-000-1234\",\n \"email\": \"amy_shaw@gmail.com\"\n }\n]" }, { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table?skip=0&top=10&filter=&select=&orderby=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "query": [ { "key": "skip", "value": "0" }, { "key": "top", "value": "10" }, { "key": "filter", "value": "" }, { "key": "select", "value": "" }, { "key": "orderby", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" } ] }, { "name": "Create Record", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"Email\": \"david@landscaping.com\",\r\n \"Name\": \"David Henderson\",\r\n \"LastName\": \"Henderson\",\r\n \"Phone\": \"1112223333\",\r\n \"FirstName\" : \"David\"\r\n}" }, "url": { "raw": "{{restapi-baseurl}}/api/v1/tables/:table", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "tables", ":table" ], "variable": [ { "key": "table", "value": "Customer", "description": "(Required) Table name" } ] } }, "response": [ { "name": "Request data invalid", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"recordID\": 123,\n \"name\": \"Bob Crenshaw\",\n \"phone\": \"1-888-925-6238\",\n \"altPhone\": \"555 456 7890\",\n \"email\": \"bob.crenshaw@gmail.com\",\n \"entity\": \"Bob's Accounting Firm\",\n \"faceBookUserName\": \"Bob Crenshaw\",\n \"firstName\": \"Bob\",\n \"instagramUserName\": \"BobsAccounting\",\n \"isOptOutOfBilling\": false,\n \"isOptOutOfMarketing\": false,\n \"lastModifiedDate\": \"2020-03-20T23:12:17.9143077Z\",\n \"lastName\": \"Crenshaw\",\n \"linkedInPublicUserName\": \"Bob Crenshaw\",\n \"mobile\": \"555 789 0987\",\n \"note\": \"\",\n \"pager\": null,\n \"tagList\": \"Sales_Leads_2020\",\n \"twitterUserName\": \"@bobcrenshaw\",\n \"website\": \"www.method.me\"\n}" }, "url": { "raw": "{{baseUrl}}/:account/tables/:table", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "RecordID. Location header contains link to created record", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"recordID\": 123,\n \"name\": \"Bob Crenshaw\",\n \"phone\": \"1-888-925-6238\",\n \"altPhone\": \"555 456 7890\",\n \"email\": \"bob.crenshaw@gmail.com\",\n \"entity\": \"Bob's Accounting Firm\",\n \"faceBookUserName\": \"Bob Crenshaw\",\n \"firstName\": \"Bob\",\n \"instagramUserName\": \"BobsAccounting\",\n \"isOptOutOfBilling\": false,\n \"isOptOutOfMarketing\": false,\n \"lastModifiedDate\": \"2020-03-20T23:12:17.9143077Z\",\n \"lastName\": \"Crenshaw\",\n \"linkedInPublicUserName\": \"Bob Crenshaw\",\n \"mobile\": \"555 789 0987\",\n \"note\": \"\",\n \"pager\": null,\n \"tagList\": \"Sales_Leads_2020\",\n \"twitterUserName\": \"@bobcrenshaw\",\n \"website\": \"www.method.me\"\n}" }, "url": { "raw": "{{baseUrl}}/:account/tables/:table", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" } ] }, { "name": "Update Record", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"LastName\": \"Anderson\",\n \"Note\": \"LastName modified 123456\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{restapi-baseurl}}/api/v1/tables/:table/:recordId", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "tables", ":table", ":recordId" ], "variable": [ { "key": "table", "value": "Customer", "description": "(Required) Table name" }, { "key": "recordId", "value": "5050", "description": "(Required) RecordId of the record" } ] } }, "response": [ { "name": "Request data invalid", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"recordID\": 123,\n \"name\": \"Bob Crenshaw\",\n \"phone\": \"1-888-925-6238\",\n \"altPhone\": \"555 456 7890\",\n \"email\": \"bob.crenshaw@gmail.com\",\n \"entity\": \"Bob's Accounting Firm\",\n \"faceBookUserName\": \"Bob Crenshaw\",\n \"firstName\": \"Bob\",\n \"instagramUserName\": \"BobsAccounting\",\n \"isOptOutOfBilling\": false,\n \"isOptOutOfMarketing\": false,\n \"lastModifiedDate\": \"2020-03-20T23:12:17.9115594Z\",\n \"lastName\": \"Crenshaw\",\n \"linkedInPublicUserName\": \"Bob Crenshaw\",\n \"mobile\": \"555 789 0987\",\n \"note\": \"\",\n \"pager\": null,\n \"tagList\": \"Sales_Leads_2020\",\n \"twitterUserName\": \"@bobcrenshaw\",\n \"website\": \"www.method.me\"\n}" }, "url": { "raw": "{{baseUrl}}/:account/tables/:table/:recordId", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table", ":recordId" ], "variable": [ { "key": "account" }, { "key": "table" }, { "key": "recordId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Record updated successfully", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"recordID\": 123,\n \"name\": \"Bob Crenshaw\",\n \"phone\": \"1-888-925-6238\",\n \"altPhone\": \"555 456 7890\",\n \"email\": \"bob.crenshaw@gmail.com\",\n \"entity\": \"Bob's Accounting Firm\",\n \"faceBookUserName\": \"Bob Crenshaw\",\n \"firstName\": \"Bob\",\n \"instagramUserName\": \"BobsAccounting\",\n \"isOptOutOfBilling\": false,\n \"isOptOutOfMarketing\": false,\n \"lastModifiedDate\": \"2020-03-20T23:12:17.9115594Z\",\n \"lastName\": \"Crenshaw\",\n \"linkedInPublicUserName\": \"Bob Crenshaw\",\n \"mobile\": \"555 789 0987\",\n \"note\": \"\",\n \"pager\": null,\n \"tagList\": \"Sales_Leads_2020\",\n \"twitterUserName\": \"@bobcrenshaw\",\n \"website\": \"www.method.me\"\n}" }, "url": { "raw": "{{baseUrl}}/:account/tables/:table/:recordId", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table", ":recordId" ], "variable": [ { "key": "account" }, { "key": "table" }, { "key": "recordId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Delete Record", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{restapi-baseurl}}/api/v1/tables/:table/:recordId", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "tables", ":table", ":recordId" ], "variable": [ { "key": "table", "value": "Customer", "description": "(Required) Table name" }, { "key": "recordId", "value": "5050", "description": "(Required) RecordId of the record" } ] } }, "response": [ { "name": "Request data invalid", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table/:recordId", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table", ":recordId" ], "variable": [ { "key": "account" }, { "key": "table" }, { "key": "recordId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Record deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table/:recordId", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table", ":recordId" ], "variable": [ { "key": "account" }, { "key": "table" }, { "key": "recordId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get Record", "request": { "method": "GET", "header": [], "url": { "raw": "{{restapi-baseurl}}/api/v1/tables/:table/:recordId", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "tables", ":table", ":recordId" ], "query": [ { "key": "select", "value": "FirstName,LastName", "description": "Comma separated list of fields to be returned in the response", "disabled": true } ], "variable": [ { "key": "table", "value": "Customer", "description": "(Required) Table name" }, { "key": "recordId", "value": "5051", "description": "(Required) RecordId of the record" } ] } }, "response": [ { "name": "Record Data", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table/:recordId?select=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table", ":recordId" ], "query": [ { "key": "select", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" }, { "key": "recordId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"recordID\": 123,\n \"name\": \"Bob Crenshaw\",\n \"phone\": \"1-888-925-6238\",\n \"altPhone\": \"555 456 7890\",\n \"email\": \"bob.crenshaw@gmail.com\",\n \"entity\": \"Bob's Accounting Firm\",\n \"faceBookUserName\": \"Bob Crenshaw\",\n \"firstName\": \"Bob\",\n \"instagramUserName\": \"BobsAccounting\",\n \"isOptOutOfBilling\": false,\n \"isOptOutOfMarketing\": false,\n \"lastModifiedDate\": \"2020-03-20T23:12:17.908772Z\",\n \"lastName\": \"Crenshaw\",\n \"linkedInPublicUserName\": \"Bob Crenshaw\",\n \"mobile\": \"555 789 0987\",\n \"note\": \"\",\n \"pager\": null,\n \"tagList\": \"Sales_Leads_2020\",\n \"twitterUserName\": \"@bobcrenshaw\",\n \"website\": \"www.method.me\"\n}" }, { "name": "Record not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table/:recordId?select=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table", ":recordId" ], "query": [ { "key": "select", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" }, { "key": "recordId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Request data invalid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/:account/tables/:table/:recordId?select=", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table", ":recordId" ], "query": [ { "key": "select", "value": "" } ], "variable": [ { "key": "account" }, { "key": "table" }, { "key": "recordId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" } ] }, { "name": "Sync Record", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{restapi-baseurl}}/api/v1/tables/:table/:recordId/Sync", "host": [ "{{restapi-baseurl}}" ], "path": [ "api", "v1", "tables", ":table", ":recordId", "Sync" ], "variable": [ { "key": "table", "value": "Invoice", "description": "(Required) Table name" }, { "key": "recordId", "value": "1234" } ] } }, "response": [ { "name": "Request data invalid", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"recordID\": 123,\n \"name\": \"Bob Crenshaw\",\n \"phone\": \"1-888-925-6238\",\n \"altPhone\": \"555 456 7890\",\n \"email\": \"bob.crenshaw@gmail.com\",\n \"entity\": \"Bob's Accounting Firm\",\n \"faceBookUserName\": \"Bob Crenshaw\",\n \"firstName\": \"Bob\",\n \"instagramUserName\": \"BobsAccounting\",\n \"isOptOutOfBilling\": false,\n \"isOptOutOfMarketing\": false,\n \"lastModifiedDate\": \"2020-03-20T23:12:17.9143077Z\",\n \"lastName\": \"Crenshaw\",\n \"linkedInPublicUserName\": \"Bob Crenshaw\",\n \"mobile\": \"555 789 0987\",\n \"note\": \"\",\n \"pager\": null,\n \"tagList\": \"Sales_Leads_2020\",\n \"twitterUserName\": \"@bobcrenshaw\",\n \"website\": \"www.method.me\"\n}" }, "url": { "raw": "{{baseUrl}}/:account/tables/:table", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "RecordID. Location header contains link to created record", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"recordID\": 123,\n \"name\": \"Bob Crenshaw\",\n \"phone\": \"1-888-925-6238\",\n \"altPhone\": \"555 456 7890\",\n \"email\": \"bob.crenshaw@gmail.com\",\n \"entity\": \"Bob's Accounting Firm\",\n \"faceBookUserName\": \"Bob Crenshaw\",\n \"firstName\": \"Bob\",\n \"instagramUserName\": \"BobsAccounting\",\n \"isOptOutOfBilling\": false,\n \"isOptOutOfMarketing\": false,\n \"lastModifiedDate\": \"2020-03-20T23:12:17.9143077Z\",\n \"lastName\": \"Crenshaw\",\n \"linkedInPublicUserName\": \"Bob Crenshaw\",\n \"mobile\": \"555 789 0987\",\n \"note\": \"\",\n \"pager\": null,\n \"tagList\": \"Sales_Leads_2020\",\n \"twitterUserName\": \"@bobcrenshaw\",\n \"website\": \"www.method.me\"\n}" }, "url": { "raw": "{{baseUrl}}/:account/tables/:table", "host": [ "{{baseUrl}}" ], "path": [ ":account", "tables", ":table" ], "variable": [ { "key": "account" }, { "key": "table" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" } ] } ], "event": [ { "listen": "prerequest", "script": { "id": "e4b5f0c5-0810-4712-ae82-d512b750eff7", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "24d234a5-5ec0-469f-a839-157d54fb820f", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{oauth_access_token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "id": "9459caeb-bf92-4b77-802b-d2f121afe043", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "fcb89384-b426-4d0e-bc0b-14cc74eae19a", "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "id": "f8d302b9-2a7e-4460-8060-6d4411372e96", "key": "restapi-baseurl", "value": "https://rest.method.me", "type": "string" } ], "protocolProfileBehavior": {} }