Created by Craig Edwards, last modified on 03 Nov 2017

Summary

API Endpoint Address

https://api.trackrecordpro.co.uk/3.0/users

Minimum Supported API Version3.0
Supported Methods

GET
POST
PUT
DELETE

Access LevelEveryone
DescriptionEach user who can log into the system has an entry in the users table accessible via the users endpoint. When a user is added or modified you cannot modify the password for the user via this endpoint. Instead or alongside this, you must use the password endpoint to set the password.

GET users

GET /3.0/users HTTP/1.1

Details

Retrieve one or more users from the database

{
    "request": {
        "url": "\/3.0\/users\/id<3",
        "endpoint": "users",
        "requested_version": "3.0",
        "api_version": 3,
        "request_method": "Get",
        "timestamp": 1507558417,
        "session": null
    },
    "pagination": {
        "total_pages": 24,
        "total_records": 692
    },
    "response": [
        {
            "id": 1,
            "username": "craig.edwards",
            "email": "craig.edwards@comech.co.uk",
            "first_name": "Craig",
            "last_name": "Edwards",
            "phone": "07715 904822",
            "email_confirmed": 1,
            "password_last_changed": "2017-09-27",
            "permissions": null,
            "company_id": 1,
            "reminders": 1,
            "data": null,
            "company": {
                "id": 1,
                "name": "TrackRecordPro",
                "created": "2017-10-09 08:42:37",
                "logo": "trp.png",
                "subdomain": "trackrecordpro",
                "styles": {
                    "test": {
                        "foo": "bar",
                        "baz": 1
                    },
                    "test2": 666.7
                },
                "data": null
            }
        },
        {
            "id": 2,
            "username": "test.user",
            "email": "testuser@comech.co.uk",
            "first_name": "Test",
            "last_name": "User",
            "phone": "01332 867700",
            "email_confirmed": 1,
            "password_last_changed": null,
            "permissions": null,
            "company_id": 1,
            "reminders": 1,
            "data": null,
            "company": {
                "id": 1,
                "name": "TrackRecordPro",
                "created": "2017-10-09 08:42:37",
                "logo": "trp.png",
                "subdomain": "trackrecordpro",
                "styles": {
                    "test": {
                        "foo": "bar",
                        "baz": 1
                    },
                    "test2": 666.7
                },
                "data": null
            }
        }
    ]
}

POST users

POST /3.0/users HTTP/1.1

Details

Update an entry in the users table. You must include the fields and values to update as a JSON object in the POST data.

{
    "request": {
        "url": "\/3.0\/users\/id=42",
        "endpoint": "users",
        "requested_version": "3.0",
        "api_version": 3,
        "request_method": "Post",
        "timestamp": 1507622071,
        "session": null
    },
    "response": {
        "records_updated": 1,
        "records_found": 1
    }
}

 

 

PUT users

PUT /3.0/users HTTP/1.1

Details

Describe the PUT method

Example here

DELETE users

DELETE /3.0/users HTTP/1.1

Details

Describe the DELETE method

Example here

Field Definitions

Expand

Invalid license

Your evaluation license of PocketQuery expired. Please contact an administrator to purchase a new license.