{"info":{"_postman_id":"c46e2c37-a3ce-4d3d-b8f7-4f83789a63c2","name":"Workd API","description":"

Grants access to the data in the objects.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17931964","collectionId":"c46e2c37-a3ce-4d3d-b8f7-4f83789a63c2","publishedId":"UV5f7DUL","public":true,"customColor":{"top-bar":"F0F2Fe","right-sidebar":"303030","highlight":"5F70F2"},"publishDate":"2021-10-28T17:59:48.000Z"},"item":[{"name":"Object Service","item":[{"name":"GET Requests","item":[{"name":"Overview","item":[{"name":"Getting Records","event":[{"listen":"test","script":{"id":"3460aea1-b6c2-4442-8257-b72eee55e5e7","exec":[""],"type":"text/javascript"}}],"id":"ffea1499-f91a-4c8a-a060-217eb87e4300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"url":"https://api.workd.com/object/:objectName?json={{json}}","urlObject":{"protocol":"https","path":["object",":objectName"],"host":["api","workd","com"],"query":[{"description":{"content":"

json Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Required	Description
objectNameAlias	false	A string defining what to reference this object by in the query. Allows usage of multiple instances of the same resource in a single query
filter	false	An object defining the filter used to filter out the result record set
sort	false	An array of string field names, each prefaced with + for asc and - for desc order
page	false	An object containing two properties. size, the number of records to return, defaulting to 10. page, the offset, starting at and defaulting to 1
fields	false	An array of field name strings or aliased field name objects. [] or [''] denotes ALL. Defaults to [''].
includes	false	An array of includes, or joins, to make to other resources. This property can nest in itself to provide further nested results
group	false	An array of fields to group the result set by. Defaults to ['_id']. An empty array [] will result in no grouping and should be used carefully with includes
format	false	A map of tablename.fieldname notation fieldnames with format definition values. {$reference: '{{tableName.fieldName}}' notation may be used for the formatter values
getDeleted	false	A boolean, denoting whether to return 'soft deleted' values. Defaults to false.
returnTotalRecords	false	A boolean, denoting whether to return the totalRecords meta value. Should be used whenever totalRecords is unused. Defaults to true

","type":"text/plain"},"key":"json","value":"{{json}}"}],"variable":[{"type":"any","value":"{{objectName}}","key":"objectName"}]}},"response":[{"id":"a7c1188c-aaae-4414-b3fb-2407f19fc55e","name":"Getting Records","originalRequest":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"url":{"raw":"https://api.workd.com/object/:objectName?json={{json}}","protocol":"https","host":["api","workd","com"],"path":["object",":objectName"],"query":[{"key":"json","value":"{{json}}","description":"### json Properties\n\n| Property | Required | Description |\n| --------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| objectNameAlias | false | A string defining what to reference this object by in the query. Allows usage of multiple instances of the same resource in a single query |\n| filter | false | An object defining the filter used to filter out the result record set |\n| sort | false | An array of string field names, each prefaced with + for asc and - for desc order |\n| page | false | An object containing two properties. size, the number of records to return, defaulting to 10. page, the offset, starting at and defaulting to 1 |\n| [fields](#markdown-header-fields) | false | An array of field name strings or aliased field name objects. [] or ['\\*'] denotes ALL. Defaults to ['\\*']. |\n| includes | false | An array of includes, or joins, to make to other resources. This property can nest in itself to provide further nested results |\n| [group](#markdown-header-group) | false | An array of fields to group the result set by. Defaults to ['_id']. An empty array [] will result in no grouping and should be used carefully with includes |\n| format | false | A map of tablename.fieldname notation fieldnames with format definition values. {$reference: '{{tableName.fieldName}}' notation may be used for the formatter values |\n| getDeleted | false | A boolean, denoting whether to return 'soft deleted' values. Defaults to false. |\n| returnTotalRecords | false | A boolean, denoting whether to return the totalRecords meta value. Should be used whenever totalRecords is unused. Defaults to true |\n\n\n\nTEST\n\nTEST\n\n* TEST\n* TEST\n* TEST"}],"variable":[{"key":"objectName","value":"{{objectName}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ffea1499-f91a-4c8a-a060-217eb87e4300"}],"id":"09782983-fc12-40ee-a592-bf2089bec8cc","_postman_id":"09782983-fc12-40ee-a592-bf2089bec8cc","description":""},{"name":"Fields","item":[{"name":"Selecting Specific Fields","event":[{"listen":"test","script":{"id":"3460aea1-b6c2-4442-8257-b72eee55e5e7","exec":[""],"type":"text/javascript"}}],"id":"79f0cf4e-3839-48b7-9156-385339de4f10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"url":"https://api.workd.com/object/:objectName?json={{json}}","urlObject":{"protocol":"https","path":["object",":objectName"],"host":["api","workd","com"],"query":[{"description":{"content":"

To select specific fields, pass an array of field names:

{\n    \"fields\": [\"_id\", \"name\", \"city\"] \n}\n

To select all fields, use a wildcard * operator:

{\n    \"fields\": [\"*\"] \n}\n

An empty fields array will also return all fields, provided the fields being specified belong to the base object in the query.

{\n    \"fields\": [] \n}\n

The base object in a query may be joined to one or more additional resources using the includes property. This equivalent to a join in SQL.

Within the includes clause, an empty fields array will return no fields except the foreignField that was used to perform the join. This is useful when grouping and aggregating.

The below query gives the number of unique invoices for each customer. Note that there are two fields properties; one for the base object and one for the object being joined.

Joined invoice records are grouped by their foreign key to a customer (fk_customer__id). The fields array is left empty because non-aggregate fields cannot be returned from a grouped object.

{\n    \"fields\": [\n        \"_id\",\n        \"name\",\n        {\n           \"countUniqueInvoices: {\n                \"$countDistinct\": {\n                    \"$reference\": \"invoice._id\"\n                }\n            } \n        } \n    ],\n    \"includes\": [\n        {\n            \"objectName\": \"invoice\",\n            \"type\": \"inner\",\n            \"localField\": \"_id\",\n            \"foreignField: \"fk_customer__id\"\n            \"fields\": [],\n            \"group\": [\"fk_customer__id\"],\n        }\n    ]\n}\n

To alias a field name in the results, use the $reference operator:

{\n    \"fields\": [\n        {\n            \"customerId\": {\n              \"$reference\": {\n                    \"_id\"\n                }  \n            }\n        },\n        \"name\",\n    ]\n}\n

fields supports arithmetic operators such as $add, $subtract, $multiply, and $divide.

Assume our schema contains a customer object with creditBalance and creditLimit properties. Using the $subtract operator, we can calculate the creditRemaining for each customer:

{\n    \"fields\": [\n        \"name\",\n        \"creditLimit\",\n        \"creditBalance\",\n        {\n            \"creditRemaining\": {\n              \"$subtract\": [\n                    { \"$reference\": \"creditLimit\" },\n                    { \"$reference\": \"creditBalance\" }\n                ]  \n            }\n        }\n    ]\n}\n

fields also supports the $concat operator to combine text values.

{\n    \"fields\": [\n        \"firstName\",\n        \"lastName\",\n        {\n            \"lastThenFirst\": {\n              \"$concat\": [\n                    { \"$reference\": \"lastName\" },\n                    \", \",\n                    { \"$reference\": \"firstName\" }\n                ]  \n            }\n        }\n    ]\n}\n

The $coalesce operator can be used to return the first non-null value in a list of values.

{\n    \"fields\": [\n        \"firstName\",\n        \"lastName\",\n        \"cellPhone\",\n        \"homePhone\",\n        {\n            \"contactPhone\": {\n              \"$coalesce\": [\n                    { \"$reference\": \"cellPhone\" },\n                    { \"$reference\": \"homePhone\" }\n                ]  \n            }\n        }\n    ]\n}\n

The $switch operator allows for values to be conditionally returned based on CASE-THEN logic.

{\n    \"fields\": [\n        \"description\",\n        \"isFinalSale\",\n        \"price\",\n        \"shipping\",\n        \"total\",\n        {\n            \"totalAfterDiscounts\": {\n              \"$switch\": {\n                \"branches\": [\n                    {\n                        \"case\": {\n                           \"isFinalSale\": true \n                        },\n                        \"then\": {\n                            \"$multiply\": [\n                                {\n                                    \"$reference\": \"total\"\n                                },\n                                0.50\n                            ]\n                        } \n                    },\n                    {\n                        \"case\": {\n                           \"price\": {\n                                \">=\": 100.00\n                            } \n                        },\n                        \"then\": {\n                            \"$subtract\": [\n                                {\n                                    \"$reference\": \"total\"\n                                },\n                                {\n                                    \"$reference\": \"shipping\"\n                                },\n                            ]\n                        } \n                    }\n                ],\n                \"default\": {\n                    \"$reference: \"total\"\n                }\n              }  \n            }\n        }\n    ]\n}\n

In this example, a product is evaluated for discounts. Items marked as final sale receive a 50% discount, while any regular (non-sale) items over $100.00 qualify for free shipping.

Product A is neither final sale nor over $100, so neither case within branches is matched. The default value is used instead, which references the value in the total field.

Product B is a final sale item. The first case within branches is matched and the totalAfterDiscounts value is computed by multiplying the total by 0.5. No further cases are evaluated.

Product C is a non-sale item with a price greater than $100.00. The second case within branches is matched and totalAfterDiscounts is computed by subtracting the shipping cost from the total.

\n","type":"text/plain"},"key":"json","value":"{{json}}"}],"variable":[{"type":"any","value":"{{objectName}}","key":"objectName"}]}},"response":[{"id":"83b133b5-3796-4491-a0c4-c6ec36c63c98","name":"Conditionals","originalRequest":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"url":{"raw":"https://api.workd.com/object/:objectName?json={\"fields\":[\"description\",\"isFinalSale\",\"price\",\"shipping\",\"total\",{\"totalAfterDiscounts\":{\"$switch\":{\"branches\":[{\"case\":{\"isFinalSale\":true},\"then\":{\"$multiply\":[{\"$reference\":\"total\"},0.5]}},{\"case\":{\"price\":{\">=\":100}},\"then\":{\"$subtract\":[{\"$reference\":\"total\"},{\"$reference\":\"shipping\"}]}}],\"default\":{\"$reference\":\"total\"}}}}]}","protocol":"https","host":["api","workd","com"],"path":["object",":objectName"],"query":[{"key":"json","value":"{\"fields\":[\"description\",\"isFinalSale\",\"price\",\"shipping\",\"total\",{\"totalAfterDiscounts\":{\"$switch\":{\"branches\":[{\"case\":{\"isFinalSale\":true},\"then\":{\"$multiply\":[{\"$reference\":\"total\"},0.5]}},{\"case\":{\"price\":{\">=\":100}},\"then\":{\"$subtract\":[{\"$reference\":\"total\"},{\"$reference\":\"shipping\"}]}}],\"default\":{\"$reference\":\"total\"}}}}]}"}],"variable":[{"key":"objectName","value":"product"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":" {\n \"data\": [\n {\n description: \"Regular product\",\n isFinalSale: false,\n price: 59.99,\n shipping: 5.00,\n total: 64.99,\n totalAfterDiscounts: 64.99,\n },\n {\n description: \"Final sale product\",\n isFinalSale: true,\n price: 79.99,\n shipping: 5.00,\n total: 84.99,\n totalAfterDiscounts: 42.49,\n },\n {\n description: \"Regular product with free shipping\",\n isFinalSale: false,\n price: 109.99,\n shipping: 8.00,\n total: 117.99,\n totalAfterDiscounts: 109.99,\n },\n ...\n ],\n \"meta\": {...}\n }\n\n"}],"_postman_id":"2fec3fdf-5c88-45fc-803f-052735599983"}],"id":"dc893444-dda2-49c6-9ea7-307d4e46543e","_postman_id":"dc893444-dda2-49c6-9ea7-307d4e46543e","description":""},{"name":"Filter","item":[{"name":"Filter by Value","event":[{"listen":"test","script":{"id":"3460aea1-b6c2-4442-8257-b72eee55e5e7","exec":[""],"type":"text/javascript"}}],"id":"7f012f82-56f7-4baf-b528-2bef18a20361","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"url":"https://api.workd.com/object/:objectName?json={{json}}","urlObject":{"protocol":"https","path":["object",":objectName"],"host":["api","workd","com"],"query":[{"description":{"content":"

Use the $filter property to filter results:

{\n    \"fields\": [\"name\", \"state\"],\n    \"filter\": {\n        \"state\": {\n            \"=\": \"CA\" \n        }\n    } \n}\n

For equality comparisons, the = operator is implicit. The filter below is equivalent to the filter above:

{\n    \"fields\": [\"name\", \"state\"],\n    \"filter\": {\n        \"state\": \"CA\"\n    } \n}\n

Equality Operators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Description
`=`	Equal to
`<>` or `!=`	Not Equal to

The IN and NOT IN operators allow filtering against a list of values:

{\n    \"fields\": [\"name\", \"state\"],\n    \"filter\": {\n        \"state\": {\n            \"IN\": [\"CA\", \"FL\", \"NY\"]\n        }\n    } \n}\n

List Operators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Description
`IN`	In
`NOT IN`	Not In

$filter also supports ranges:

{\n    \"fields\": [\"_id\", \"name\"],\n    \"filter\": {\n        \"_id\": {\n            \">\": 2,\n            \"<=\" 5\n        }\n    } \n}\n

Range Operators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Description
`<`	Less than
`<=`	Less than or Equal to
`>`	Greater than
`>=`	Greater than or Equal to

Use NULL operators to filter by or against NULL values:

{\n    \"fields\": [\"_id\", \"price\", discount\", \"total\"],\n    \"filter\": {\n        \"discount\": {\n            \"IS NOT NULL\": true,\n        }\n    } \n}\n

NULL Operators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Description
`IS NULL`	Is Null
`IS NOT NULL`	Is Not Null

Text operators can be used on varchar fields:

{\n    \"fields\": [\"_id\", \"firstName\"],\n    \"filter\": {\n        \"firstName\": {\n            \"LIKE\": \"ro\",\n        }\n    } \n}\n

Text Operators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Description
`LIKE`	Like
`NOT LIKE`	Not Like

Multiple fields and operators can be combined within the same filter:

{\n    \"fields\": [\"_id\", \"city\", \"state\", \"yearToDateSales\"],\n    \"filter\": {\n        \"state\": \"CA\",\n        \"city\": {\n            \"LIKE\": \"San\"\n        },\n        \"yearToDateSales\": {\n            \">\": 25000\n        }\n    } \n}\n

filter supports the logical operators $and and $or. For a record to match, all conditions within the $and property must be true, while at least one condition within the $or property must be true.

Implicitly, properties at any level of a filter that are not within an $or clause are evaluated as if they were within an $and clause.\nThe following filters are equivalent:

{\n    \"fields\": [\"_id\", \"city\", \"state\"],\n    \"filter\": {\n        \"state\": \"CA\",\n        \"city\": {\n            \"LIKE\": \"San\"\n        },\n    } \n}\n\n{\n    \"fields\": [\"_id\", \"city\", \"state\"],\n    \"filter\": {\n        \"$and\": [\n            {\n                \"state\": \"CA\"\n            },\n            {\n                \"city\": {\n                    \"LIKE\": \"San\"\n                }\n            }\n        ]\n    } \n}\n

$and and $or operators can be arbitrarily nested.

The following filter will match any customer record with a city value like %SAN% AND where at least one of the following is true:

state === \"CA\" AND monthToDateSales > 12000
state === \"TX\" AND monthToDateSales > 8000

Note that the innermost levels of the $or clause, each containing state and monthToDateSales, are impliclity evaluated as being an $and clause; both conditions within must be true.

{\n    \"fields\": [\"_id\", \"city\", \"state\", \"monthToDateSales\"],\n    \"filter\": {\n        \"$and\": [\n            {\n                \"city\": {\n                    \"LIKE\": \"San\"\n                }\n            }\n        ],\n        \"$or\": [\n            {\n                \"state\": \"CA\"\n                \"monthToDateSales\": {\n                    \">\": 12000\n                }\n            },\n            {\n                \"state\": \"TX\"\n                \"monthToDateSales\": {\n                    \">\": 8000\n                }\n            },\n        ]\n    } \n}\n

The $reference operator can be used to compute filter values based on actual or computed values from one or more fields. Typically other operators are used in conjunction with $reference.

Here the < (less than), $subtract, and $reference operators are used to query all customers that have not been called in the past 90 days (i.e. the lastCallDate is less than the current date minus 90 days).

{\n    \"fields\": [\"_id\", \"phone\", \"lastCallDate\"],\n    \"filter\": {\n        \"lastCallDate\": {\n            \"<\": {\n               \"$subtract\": [\n                    { \"$reference\": \"$now\" },\n                    \"90 days\"\n                ] \n            }\n        }\n    } \n}\n

Referencing a joined object in the top-level filter of a query is equivalent to adding another condition to a SQL WHERE clause. \nThe object name must be specified when referencing a field on another resource.

The following query returns the quantity and invoice number for all customers in the state of New York who purchased a particular product.\nNote that the join is an INNER join and that the state field within the query filter is prefixed by the customer object name followed by a ..

The impact of such as filter will depend on whether the join is a LEFT join or an INNER join, as with SQL.\nFiltering a LEFT joined object will only filter the nested records within each parent record, and have no effect on the total number of parent records returned, while filtering an INNER joined object will filter the parent records themselves.

{\n    \"fields\": [\n        \"fk_invoice__id\",\n        \"quantity\"\n    ],\n    \"includes: [\n        {\n            \"objectName\": \"invoice\", \n            \"type\": \"inner\", \n            \"localField\": \"fk_invoice__id\",\n            \"foreignField\": \"_id\",\n            \"fields\": [],\n            \"includes: [\n                {\n                    \"objectName\": \"customer\", \n                    \"type\": \"inner\", \n                    \"localField\": \"fk_customer__id\",\n                    \"foreignField\": \"_id\",\n                    \"fields\": []\n                }\n            ]\n        }\n    ],\n    \"filter\": {\n        \"fk_product__id\": 177,\n        \"customer.state\": \"NY\"\n    }\n}\n

","type":"text/plain"},"key":"json","value":"{{json}}"}],"variable":[{"type":"any","value":"{{objectName}}","key":"objectName"}]}},"response":[{"id":"86c21baa-6733-40b0-bf6c-8004b2a0b478","name":"Filtering on Joined Objects","originalRequest":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.workd.com/object/:objectName?json={\"object\":\"object/invoice_lines\",\"fields\":[\"fk_invoice__id\",\"quantity\"],\"includes\":[{\"objectName\":\"invoice\",\"type\":\"inner\",\"localField\":\"fk_invoice__id\",\"foreignField\":\"_id\",\"fields\":[],\"includes\":[{\"objectName\":\"customer\",\"type\":\"inner\",\"localField\":\"fk_customer__id\",\"foreignField\":\"_id\",\"fields\":[]}]}],\"filter\":{\"fk_product__id\":177,\"customer.state\":\"NY\"}}","protocol":"https","host":["api","workd","com"],"path":["object",":objectName"],"query":[{"key":"json","value":"{\"object\":\"object/invoice_lines\",\"fields\":[\"fk_invoice__id\",\"quantity\"],\"includes\":[{\"objectName\":\"invoice\",\"type\":\"inner\",\"localField\":\"fk_invoice__id\",\"foreignField\":\"_id\",\"fields\":[],\"includes\":[{\"objectName\":\"customer\",\"type\":\"inner\",\"localField\":\"fk_customer__id\",\"foreignField\":\"_id\",\"fields\":[]}]}],\"filter\":{\"fk_product__id\":177,\"customer.state\":\"NY\"}}"}],"variable":[{"key":"objectName","value":"invoice_lines"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":" {\n \"data\": [\n {\n fk_invoice__id: 23711,\n quantity: 12,\n },\n {\n fk_invoice__id: 48585,\n quantity: 6,\n }\n ...\n ],\n \"meta\": {...}\n }\n"}],"_postman_id":"f1d4c82f-7588-43bb-8437-ccee3b406325"},{"name":"Filtering within Joined Objects","event":[{"listen":"test","script":{"id":"3460aea1-b6c2-4442-8257-b72eee55e5e7","exec":[""],"type":"text/javascript"}}],"id":"0b777843-c88b-41da-8553-8e9e98aae267","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"url":"https://api.workd.com/object/:objectName?json={{json}}","urlObject":{"protocol":"https","path":["object",":objectName"],"host":["api","workd","com"],"query":[{"description":{"content":"

Applying a filter within a joined object is the equivalent of adding another condition to a SQL JOIN clause.

{\n    \"fields\": [\n        \"_id\",\n        \"total,\n    ],\n    \"includes: [\n        {\n            \"objectName\": \"invoice_lines\", \n            \"type\": \"inner\", \n            \"localField\": \"fk_invoice__id\",\n            \"foreignField\": \"_id\",\n            \"fields\": [\n                \"fk_product__id\",\n                \"quantity\",\n                \"total\",\n            ],\n            \"filter\": {\n                \"fk_invoice__id\": 2\n            }\n        }\n    ]\n}\n

In this case, all invoices will be returned, but only the invoice with an _id of 2 will contain any joined invoice_line records.

\n","type":"text/plain"},"key":"json","value":"{{json}}"}],"variable":[{"type":"any","value":"{{objectName}}","key":"objectName"}]}},"response":[{"id":"86f8a350-15dd-46c2-a5a6-fad306a5d8e0","name":"Filtering within Joined Objects","originalRequest":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.workd.com/object/:objectName?json={\"object\":\"object/invoice\",\"fields\":[\"_id\",\"total\"],\"includes\":[{\"objectName\":\"invoice_lines\",\"type\":\"inner\",\"localField\":\"fk_invoice__id\",\"foreignField\":\"_id\",\"fields\":[\"fk_product__id\",\"quantity\",\"total\"],\"filter\":{\"fk_invoice__id\":2}}]}","protocol":"https","host":["api","workd","com"],"path":["object",":objectName"],"query":[{"key":"json","value":"{\"object\":\"object/invoice\",\"fields\":[\"_id\",\"total\"],\"includes\":[{\"objectName\":\"invoice_lines\",\"type\":\"inner\",\"localField\":\"fk_invoice__id\",\"foreignField\":\"_id\",\"fields\":[\"fk_product__id\",\"quantity\",\"total\"],\"filter\":{\"fk_invoice__id\":2}}]}"}],"variable":[{"key":"objectName","value":"invoice"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":" {\n \"data\": [\n {\n _id: 1,\n total: 840.55,\n invoice_lines: []\n },\n {\n _id: 2,\n total: 202.91,\n invoice_lines: [\n {\n fk_product__id: 154,\n quantity: 4,\n total: 72.95\n },\n {\n fk_product__id: 154,\n quantity: 16,\n total: 129.96\n }\n ]\n },\n {\n _id: 3,\n total: 1235.94,\n invoice_lines: []\n },\n ...\n ],\n \"meta\": {...}\n }\n"}],"_postman_id":"0b777843-c88b-41da-8553-8e9e98aae267"}],"id":"62735acb-dc49-4a3d-983f-a2726b8ccf3f","_postman_id":"62735acb-dc49-4a3d-983f-a2726b8ccf3f","description":""},{"name":"Page","item":[{"name":"Page Sizes","event":[{"listen":"test","script":{"id":"3460aea1-b6c2-4442-8257-b72eee55e5e7","exec":[""],"type":"text/javascript"}}],"id":"3c25f262-0085-4296-9394-7f035c154c71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"api_secret","value":"{{api_secret}}","type":"text"}],"url":"https://api.workd.com/object/:objectName?json={{json}}","urlObject":{"protocol":"https","path":["object",":objectName"],"host":["api","workd","com"],"query":[{"description":{"content":"

By default, a GET request will return 10 results. Use the page.size property to specify the number of results to be returned:

{\n    \"fields\": [\"_id\", \"name\"],\n    \"page\": {\n        \"size\": 3\n    } \n}\n

To offset results, use the page.page property:

{\n    \"fields\": [\"_id\", \"name\"],\n    \"page\": {\n        \"size\": 5,\n        \"page\": 2\n    } \n}\n

Note: a value of 1 will return the first page of results, a value of 2 will return the second page, and so on. A value of 0 will behave the same as a vaulue of 1, but for consistency with following values it is recommended to use 1.

To specify a sort order for query results, use the sort property.

sort accepts a list of one or more object field names, each prefixed with either a + or a - to indicate whether that field is ascending or descending, respectively.

{\n    \"fields\": [\"firstName\"],\n    sort: [\"-firstName\"]\n}\n

sort fields will be applied in the order they appear.

In this case, results are sorted by state descending and then firstName ascending.

{\n    \"fields\": [\n        \"firstName\",\n        \"state\",\n    ],\n    sort: [\n        \"-state\",\n        \"+firstName\"\n    ]\n}\n

returnTotalRecords determines whether the query result meta property should include the totalRecords property, which contains count of all records matching the query. (Remember that the page.size property will limit how many records are actually returned within the data property of the response object.)

A value of false is primarily used to improve the performance of complex or long-running queries.

If not specified, returnTotalRecords will default to true.

{\n    \"fields\": [\"_id\", \"name\", \"city\"], \n    \"returnTotalRecords: true\n}\n

By default, records deleted in Workd are soft-deleted*. This means that rather than being permanently deleted, records are instead marked with a special indicator and continue to exist in long-term storage.

*It is possible to override this behavior and permanently delete records in specific cases, but doing so is only recommended for non-critical data.

By default, soft-deleted records are excluded from object query results. Use the getDeleted parameter to include them in the results.

{\n    \"fields\": [\n        \"_id\", \n        \"name\", \n        \"city\",\n        \"_deleted_date\",\n        \"_deleted_userId\",\n    ],\n    \"getDeleted\": true\n}\n

In this example, the customer record with _id = 3 only appears in the results because getDeleted is set to true.

Authorization

Two types of Authentication are supported: Bearer Token, and API Key/Secret Pair.
- Bearer token
  - See OAuth2 Client General Information for more info
  - Authorization header must contain the value Bearer {{access_token}}
  \n
- api_key and api_secret pair
  - api_key header must contain the value {{api_key}}
  - api_secret header must contain the value {{api_secret}}
  \n
\n

\n","_postman_id":"82c4f060-6cf0-46e0-9fb1-0842ff713c20"},{"name":"OAuth2 Client General Information","item":[{"name":"Get Code - authorize endpoint","event":[{"listen":"test","script":{"id":"1d58f126-0847-40a5-83b9-572a2908d64c","exec":[""],"type":"text/javascript"}}],"id":"f5bf7f9f-2d28-4e4f-a02c-3d1d3f5c0a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{auth_endpoint}}/oauth2/authorize?client_id={{client_id}}&response_type=code&code_challenge={{code_challenge}}&code_challenge_method={{code_challenge_method}}&redirect_uri={{redirect_uri}}&is_public={{is_public}}&instance_alias={{instance_alias}}&scope=All","urlObject":{"path":["oauth2","authorize"],"host":["{{auth_endpoint}}"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"response_type","value":"code"},{"key":"code_challenge","value":"{{code_challenge}}"},{"key":"code_challenge_method","value":"{{code_challenge_method}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"{{is_public}}"},{"key":"instance_alias","value":"{{instance_alias}}"},{"key":"scope","value":"All"}],"variable":[]}},"response":[{"id":"af6cd266-e119-4f56-91d0-b741b2b5afce","name":"Get Code - authorize endpoint","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{auth_endpoint}}/oauth2/authorize?client_id={{client_id}}&response_type=code&code_challenge={{code_challenge}}&code_challenge_method={{code_challenge_method}}&redirect_uri={{redirect_uri}}&is_public={{is_public}}&instance_alias={{instance_alias}}&scope=All","host":["{{auth_endpoint}}"],"path":["oauth2","authorize"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"response_type","value":"code"},{"key":"code_challenge","value":"{{code_challenge}}"},{"key":"code_challenge_method","value":"{{code_challenge_method}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"{{is_public}}"},{"key":"instance_alias","value":"{{instance_alias}}"},{"key":"scope","value":"All"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Wed, 03 Aug 2022 20:47:57 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"ETag","value":"W/\"239d-z/CGdzUOyfI9icMSjWlAbnnIvK8\""},{"key":"Set-Cookie","value":"workdId=s%3AOnzjpW97hzirt5OqJXmCsBoGQk9blRpZ.BugdmiEKyK9E0nlNMHShQ5sQQrobBQepdFCZwZcjCfM; Path=/; Expires=Wed, 03 Aug 2022 20:52:57 GMT; HttpOnly; Secure; SameSite=Strict"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n \n \n \n \n\n\n

\n \n

\n Email *\n \n

\n Password *\n \n

\n \n Forgot Password\n \n \n \n \n

\n \n

\n \n How do I register?\n \n

\n \n

\n"}],"_postman_id":"f5bf7f9f-2d28-4e4f-a02c-3d1d3f5c0a5a"},{"name":"Get Token - authorization_code grant","event":[{"listen":"test","script":{"exec":["var jsonData = pm.response.json();","pm.environment.set(\"access_token\", jsonData.access_token);","pm.environment.set(\"refresh_token\", jsonData.refresh_token);"],"type":"text/javascript","id":"7c0e5151-7d37-4944-ad87-be1a731d287c"}}],"id":"cbeb9805-4d18-4030-978d-8681f79a7d81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"authorization_code\",\n \"client_id\":\"{{client_id}}\",\n \"client_secret\":\"{{client_secret}}\",\n \"scope\": \"All\",\n \"code\": \"{{authorization_code}}\",\n \"instance_alias\": \"{{instance_alias}}\",\n \"is_public\": true,\n \"redirect_uri\": \"{{redirect_uri}}\",\n \"code_verifier\":\"{{code_verifier}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auth_endpoint}}/oauth2/token","urlObject":{"path":["oauth2","token"],"host":["{{auth_endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"03c044a4-a1b8-43db-b67f-8c4e61f49bef","name":"Get Token - authorization_code grant","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"authorization_code\",\n \"client_id\":\"{{client_id}}\",\n \"client_secret\":\"{{client_secret}}\",\n \"scope\": \"All\",\n \"code\": \"{{authorization_code}}\",\n \"instance_alias\": \"{{instance_alias}}\",\n \"is_public\": true,\n \"redirect_uri\": \"{{redirect_uri}}\",\n \"code_verifier\":\"{{code_verifier}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auth_endpoint}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Aug 2022 20:52:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"pragma","value":"no-cache"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"5f3-j5336oJgTCBDopS5jz+DmSbzaiw\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 2591999,\n \"access_token\": \"access token here\",\n \"refresh_token\": \"refresh token here\",\n \"scope\": \"All\"\n}"}],"_postman_id":"cbeb9805-4d18-4030-978d-8681f79a7d81"},{"name":"Get Token - password grant","event":[{"listen":"test","script":{"id":"342fe00b-57a6-4c83-9caf-b1e8967a4a99","exec":["var jsonData = pm.response.json();","pm.environment.set(\"auth\", jsonData.access_token);","pm.environment.set(\"refresh_token\", jsonData.refresh_token);"],"type":"text/javascript"}}],"id":"8e8f2035-fc3b-48d4-8c8a-9c2d09736887","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"password\",\n \"client_id\":\"{{client_id}}\",\n \"scope\": \"All\",\n \"username\":\"{{username}}\",\n \"password\":\"{{password}}\",\n \"instance_alias\": \"{{instance_alias}}\",\n \"is_public\": {{is_public}}\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/token","urlObject":{"path":["oauth2","token"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"75e1ded8-2429-44a5-9363-d682a6d86e51","name":"Get Token - password","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"password\",\n \"client_id\":\"{{client_id}}\",\n \"scope\": \"All\",\n \"username\":\"{{username}}\",\n \"password\":\"{{password}}\",\n \"instance_alias\": \"{{instance_alias}}\",\n \"is_public\": {{is_public}}\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"pragma","value":"no-cache"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"5f1-j4RhxRnfJoSGngLm9IdiUiOWcbY\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Tue, 10 May 2022 17:37:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=65"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 2591999,\n \"access_token\": \"access token here\",\n \"refresh_token\": \"refresh token here\",\n \"scope\": \"All\"\n}"}],"_postman_id":"8e8f2035-fc3b-48d4-8c8a-9c2d09736887"},{"name":"Get Token - refresh_token grant","event":[{"listen":"test","script":{"id":"7e765aa2-c269-431e-92ab-54a14d3cd979","exec":["var jsonData = pm.response.json();","pm.environment.set(\"auth\", jsonData.access_token);","pm.environment.set(\"refresh_token\", jsonData.refresh_token);"],"type":"text/javascript"}}],"id":"c0ac864b-3d94-48cf-83f3-5e38e9e5f1a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"refresh_token\",\n \"client_id\":\"{{client_id}}\",\n \"scope\": \"All\",\n \"refresh_token\": \"{{refresh_token}}\",\n \"instance_alias\": \"{{instance_alias}}\",\n \"is_public\": {{is_public}}\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/token","urlObject":{"path":["oauth2","token"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"abb53153-352c-4cf3-965c-153f73819c93","name":"Get Token - refresh_token grant","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"refresh_token\",\n \"client_id\":\"{{client_id}}\",\n \"scope\": \"All\",\n \"refresh_token\": \"{{refresh_token}}\",\n \"instance_alias\": \"{{instance_alias}}\",\n \"is_public\": {{is_public}}\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"pragma","value":"no-cache"},{"key":"cache-control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"5f1-5xKNujzUyahyKFgUWLhYnQNXT3U\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Tue, 10 May 2022 17:38:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=65"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 2591999,\n \"access_token\": \"access token here\",\n \"refresh_token\": \"refresh token here\",\n \"scope\": \"All\"\n}"}],"_postman_id":"c0ac864b-3d94-48cf-83f3-5e38e9e5f1a5"},{"name":"Revoke Token - Access","event":[{"listen":"test","script":{"id":"56b9e8d1-b961-4bdf-ae34-3afd75953525","exec":[""],"type":"text/javascript"}}],"id":"c107dead-fbff-4586-8933-09b0cf822115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\":\"{{access_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/revoke","urlObject":{"path":["oauth2","revoke"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"b9a1edc0-e6f9-4554-b7b9-0dce93e67983","name":"Revoke Token - Access","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\":\"{{access_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/revoke"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Date","value":"Tue, 10 May 2022 17:39:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=65"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c107dead-fbff-4586-8933-09b0cf822115"},{"name":"Revoke Token - Refresh","event":[{"listen":"test","script":{"id":"1bacadb6-6f02-4a93-b742-d9e2656693ea","exec":[""],"type":"text/javascript"}}],"id":"5ad9e864-1cbe-4073-a4b6-d386e0cef135","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"{{refresh_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/revoke","urlObject":{"path":["oauth2","revoke"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"942cbd48-1c4c-42c4-bbb2-7093c29c6956","name":"Revoke Token - Refresh","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"{{refresh_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/oauth2/revoke"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Date","value":"Tue, 10 May 2022 17:38:59 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=65"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5ad9e864-1cbe-4073-a4b6-d386e0cef135"},{"name":"Reset Password","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"f4433183-1297-4943-8e12-51f5019c22d8"}}],"id":"7ec6fd22-891d-4995-ae28-903d6cb0ece8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{auth_endpoint}}/oauth2/reset-password?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public={{is_public}}&instance_alias={{instance_alias}}","urlObject":{"path":["oauth2","reset-password"],"host":["{{auth_endpoint}}"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"{{is_public}}"},{"key":"instance_alias","value":"{{instance_alias}}"}],"variable":[]}},"response":[{"id":"81c90438-f1da-42e4-b099-517ce863b975","name":"Reset Password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \"emailAddress\": \"test@workd.com\" }","options":{"raw":{"language":"json"}}},"url":{"raw":"{{auth_endpoint}}/oauth2/reset-password?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public={{is_public}}&instance_alias={{instance_alias}}","host":["{{auth_endpoint}}"],"path":["oauth2","reset-password"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"{{is_public}}"},{"key":"instance_alias","value":"{{instance_alias}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"a-bAsFyilMr4Ra1hIU5PyoyFRunpI\""},{"key":"Date","value":"Mon, 11 Mar 2024 19:51:58 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=65"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7ec6fd22-891d-4995-ae28-903d6cb0ece8"},{"name":"Reset Password - Form Driven","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"5542ae80-3c4b-466b-97b1-a0316ffa2a9a"}}],"id":"ed6abed4-daa4-4880-94da-5bc021961cfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{auth_endpoint}}/oauth2/reset-password?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public={{is_public}}&instance_alias={{instance_alias}}","urlObject":{"path":["oauth2","reset-password"],"host":["{{auth_endpoint}}"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"{{is_public}}"},{"key":"instance_alias","value":"{{instance_alias}}"}],"variable":[]}},"response":[{"id":"fe9ae60b-92f9-435d-bfe0-cf55e6a8d688","name":"Reset Password - Form Driven","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{auth_endpoint}}/oauth2/reset-password?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public={{is_public}}&instance_alias={{instance_alias}}","host":["{{auth_endpoint}}"],"path":["oauth2","reset-password"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"{{is_public}}"},{"key":"instance_alias","value":"{{instance_alias}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Wed, 03 Aug 2022 20:52:17 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"ETag","value":"W/\"1f1f-mK1i5ANbUWLHm3vQ7nfc2rNWjmE\""},{"key":"Set-Cookie","value":"workdId=s%3AalP4UMPl7u8XmCz6E1R82nluUat3nk8Y.xEdAdpBQ0VE9WjCgE3RdIaQ6dWoq3Rj7HexVA2nQe4M; Path=/; Expires=Wed, 03 Aug 2022 20:57:17 GMT; HttpOnly; Secure; SameSite=Strict"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n \n \n \n \n\n\n

\n \n

\n"}],"_postman_id":"ed6abed4-daa4-4880-94da-5bc021961cfb"},{"name":"Create User - Form Driven","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"a1ff3c87-50e3-465a-aa3e-c8110803f831"}}],"id":"abcd32e9-0b92-4d0c-aa2f-8539fafe3e72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{auth_endpoint}}/oauth2/create-user?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public=true&instance_alias={{instance_alias}}","urlObject":{"path":["oauth2","create-user"],"host":["{{auth_endpoint}}"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"true"},{"key":"instance_alias","value":"{{instance_alias}}"}],"variable":[]}},"response":[{"id":"ae4a6998-0ab6-4416-bb38-1c674e97728c","name":"Create User - Form Driven","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{auth_endpoint}}/oauth2/create-user?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public=true&instance_alias={{instance_alias}}","host":["{{auth_endpoint}}"],"path":["oauth2","create-user"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"true"},{"key":"instance_alias","value":"{{instance_alias}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Wed, 03 Aug 2022 20:52:21 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"ETag","value":"W/\"22c2-Ldwo3SmH/vx+Z3lfS1BtuRB7JxE\""},{"key":"Set-Cookie","value":"workdId=s%3AalP4UMPl7u8XmCz6E1R82nluUat3nk8Y.xEdAdpBQ0VE9WjCgE3RdIaQ6dWoq3Rj7HexVA2nQe4M; Path=/; Expires=Wed, 03 Aug 2022 20:57:21 GMT; HttpOnly; Secure; SameSite=Strict"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n \n \n \n \n\n\n

\n \n

\n Email *\n \n

\n Password *\n \n

\n Email *\n \n

\n \n

\n"}],"_postman_id":"abcd32e9-0b92-4d0c-aa2f-8539fafe3e72"},{"name":"Delete User - Form Driven","event":[{"listen":"test","script":{"id":"7cd86126-bbf7-4481-b5ad-f0569db2ee01","exec":[""],"type":"text/javascript"}}],"id":"c29014e6-8806-4a51-955c-ed28bc4ff68d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{auth_endpoint}}/oauth2/delete-account?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public=true&instance_alias={{instance_alias}}","urlObject":{"path":["oauth2","delete-account"],"host":["{{auth_endpoint}}"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"true"},{"key":"instance_alias","value":"{{instance_alias}}"}],"variable":[]}},"response":[{"id":"ca6356ab-657d-4a26-a279-fea177fd0f84","name":"Delete User - Form Driven","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{auth_endpoint}}/oauth2/delete-account?client_id={{client_id}}&redirect_uri={{redirect_uri}}&is_public=true&instance_alias={{instance_alias}}","host":["{{auth_endpoint}}"],"path":["oauth2","delete-account"],"query":[{"key":"client_id","value":"{{client_id}}"},{"key":"redirect_uri","value":"{{redirect_uri}}"},{"key":"is_public","value":"true"},{"key":"instance_alias","value":"{{instance_alias}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 28 Aug 2023 16:40:50 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"ETag","value":"W/\"11d0b-kmpHsV8h58v/bDR92Eh6ZLQi+V0\""},{"key":"Set-Cookie","value":"workdId=s%3A_20bF51kLZEmADaEAhuFDATKHFB9tDjV.f%2Bp%2Flqm3IhgyJaf%2FLuZupXd18ztEHxc7%2FRGtNyUm2f4; Path=/; Expires=Mon, 28 Aug 2023 16:45:50 GMT; HttpOnly; Secure; SameSite=Strict"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n \n \n \n \n \n \n\n\n

\n \n

Enter your login to delete your account

\n Email *\n \n

\n Password *\n

\n \n

\n \n Forgot Password\n \n

\n \n I understand that my account cannot be recovered and all of my records, data, and access will be lost forever.\n \n

\n \n

\n"}],"_postman_id":"c29014e6-8806-4a51-955c-ed28bc4ff68d"}],"id":"84c3c8a9-b219-40e9-bf2b-f39e77d7c4f9","description":"

OAuth2 Client General Information

Client Registration

Reach out to us at info@workd.com with the following information
- Application name
- Web page about the application
- Description
- Logo or other images
- Web page about the application’s terms of use
\n

Endpoints

Domains
- Staging – staging.auth.workd.com
- Production – auth.workd.com
\n
Routes
- Authorization- /oauth2/authorize
- Token - /oauth2/token
\n

Client Authentication

client_id and (optionally) client_secret in request
client_id and client_secret will not be longer than 64 characters (A-Z,a-z0-9./) each

Redirect URL Restrictions

All redirect urls must either use the https protocol or be a custom application schemes.

Scopes

These are dependent on the installed actions and roles in the Workd instance you are accessing. Please reach out to the instance administrator for more information.
Currently supported scope to access all data authorized for the user is 'All'

Access Token Response Properties

token_type
expires_in
scope
access_token
refresh_token (optionally)

Refresh Token Information

refresh_token is optionally included in authorization_code and password grant type response body's, depending on the availability of the grant type for the client application.
They will be included on all /token responses for these grant types if enabled for the client application and supported on the target Workd instance client whitelist.
When a refresh_token grant request is fulfilled, the previous refresh token is revoked (i.e. refresh tokens are single use)

Custom Request Properties

instance_alias is required for all requests. This contains the value of the Workd instance you are trying to gain access to
is_public is required for all requests. This contains a boolean, true or false, value, denoting whether you are trying to access the public or private (CRM) user set.

Custom Redirect URI Query Parameters

action_performed is included in redirects for the following endpoints and actions initiated by the user, to better give oauth2 clients the ability to understand what the user actually did
- /reset-password
  - password-reset:reset is set when the user successfully resets their password
  - password-reset:requested is set when the user requests a password reset email
  \n
- /create-user
  - create-user:created is set when the user successfully creates a new account and a password set email is sent
  \n
- /delete-account
  - delete-account:cancelled is set when the user backs out of the delete account page
  - delete-account:completed is set when the user successfully deletes their account
  \n
\n

Requests

\n","_postman_id":"84c3c8a9-b219-40e9-bf2b-f39e77d7c4f9"}],"event":[{"listen":"prerequest","script":{"id":"6cc1c6af-903e-4764-b248-630f468da9ea","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b067c254-112e-4c87-a6fe-749201a0d5f9","type":"text/javascript","exec":[""]}}],"variable":[{"key":"api_key","value":"{{api_key}}"},{"key":"api_secret","value":"{{api_secret}}"}]}

json Properties

Authorization

Login

Forgot Password

Create User

Delete Account

Enter your login to delete your account

OAuth2 Client General Information

Client Registration

Endpoints

Client Authentication

Redirect URL Restrictions

Scopes

Access Token Response Properties

Refresh Token Information

Custom Request Properties

Custom Redirect URI Query Parameters

Requests