Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Custom Fields

Get User Custom Fields
GET /customfields/users 
https://api.relesysapp.net/api/v1.3/customfields/users
Get a list of user custom fields.
Default sort is by name in ascending order.
Scopes: relesys.api, relesys.api:read, relesys.api.users, relesys.api.users:read
Query String
externalId string Filterable Sortable optional
id string / guid Filterable optional
name string Filterable Sortable optional
type string Filterable Sortable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"2a09d607-9a98-4996-ad4b-f4c69306bebd","externalId":"externalone","name":"User custom field example 1","type":"MultilineText"},{"id":"437d0878-3afa-45a8-ad7e-3818123d4017","externalId":"externaltwo","name":"User custom field example 2","type":"MultilineText"}]}
object
  count integer      
  ⯈ data array[object]      
   externalId string      
   id string / guid      
   name string      
   type string      
  nextUrl string      
  previousUrl string