API Reference

Retrieve a list of types

Description

The Types endpoint is used to discover what types of records exist and their attributes. This endpoint lets you know what to expect from the Records endpoints.

GET /graph/types

🚧

Required OAuth Scopes:

graph:read

Parameters

ParameterInTypeRequiredDescription
$expandquerystringfalseReturns related resources inline with the main resource

Expand Options

Expands Options Supported
relationships

Code Samples

curl -X GET https://api.app.wdesk.com/platform/v1/graph/types  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'

http GET https://api.app.wdesk.com/platform/v1/graph/types  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"

wget --method=GET "https://api.app.wdesk.com/platform/v1/graph/types" \
 --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/types', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of Type 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": "User",
      "properties": [
        "userName",
        "firstName",
        "lastName",
        "email"
      ]
    }
  ]
}