Users - JSON API

Table of Contents

1. GET users
2. GET users/[id]

Introduction

1.0 GET /users/

Retrieves list of users details

Request

https://rest.efiling.local/2/users?filters[updatedFrom]=20211116&filters[updatedTo]=20221116

Response

A collection of 'user' resource will be returned.

2.0 GET /users/[id]

Retrieves user details

Request

GET /users/123

Response

A 'user' resource will be returned. DateTime is represented as YmdHis

{
    "id": 123,
    "created_at": 20211004163247,
    "updated_at": 20211004163247,
    "username": "abc@gmail.com",
    "organisation": "",
    "title": "Mr",
    "firstname": "Joe",
    "lastname": "Blogg",
    "contacts": [
        {
            "assignment": "PRIMARY",
            "method": "NUMBER",
            "value": 7712123123
        },
        {
            "assignment": "PRIMARY",
            "method": "EMAIL",
            "value": "abc@gmail.com"
        }
    ],
    "addresses": [
        {
            "assignment": "PRIMARY",
            "line1": 2a,
            "line2": "Rickyard Barn",
            "line3": "",
            "town": "Blisworth",
            "postcode": "NN3 6WL",
            "country": "UNITED KINGDOM"
        }
    ]
},