API Reference

Retrieve a list of records

Description

Returns a list of records matching the provided filters. At least one filter is required. If no filter is provided an error will be returned.

GET /graph/records

🚧

Required OAuth Scopes:

graph:read

Parameters

ParameterInTypeRequiredDescription
$expandquerystringfalseReturns related resources inline with the main resource
$filterquerystringfalseThe properties to filter the results by.

Filter Options

Available logical operators: and, or

NamePredicates Supported
ideq, ne
properties.< property name >eq, ne, lt, gt, le, ge
typeeq, ne

Expand Options

Expands Options Supported
relationships

Code Samples

curl -X GET https://api.app.wdesk.com/platform/v1/graph/records  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://api.app.wdesk.com/platform/v1/graph/records  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/platform/v1/graph/records" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/platform/v1/graph/records', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of Record objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn't appear. If the request returns no results at all, data contains an empty array.

Example Responses


{
  "data": [
    {
      "id": "931c768b-c3dd-4392-b56e-06d7d6ff88a6",
      "properties": {
        "dateReported": {
          "datatype": "date-time",
          "value": "2019-12-11T00:00:00Z"
        },
        "email": {
          "datatype": "string",
          "value": "[email protected]"
        },
        "hyperlink": {
          "datatype": "map",
          "value": {
            "text": "Example Website",
            "url": "www.example.com"
          }
        }
      },
      "type": "Issue"
    }
  ]
}