Users

Users Documentation

User [LIST]

User [LIST]

Request

Endpoint

GET /api/v2/account_lists/e70396ec-43d6-41a2-86bd-06cdd188d97f/users
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "34209a1d-30e8-4e5a-9b4e-de7ce20b02e4",
      "type": "users",
      "attributes": {
        "created_at": "2021-11-23T14:38:04Z",
        "first_name": "Jc",
        "last_name": null,
        "updated_at": "2021-11-23T14:38:04Z",
        "updated_in_db_at": "2021-11-23T14:38:04Z"
      }
    },
    {
      "id": "8b1779f1-b99d-451d-a201-11546b59c6e7",
      "type": "users",
      "attributes": {
        "created_at": "2021-11-23T14:38:04Z",
        "first_name": "Mai",
        "last_name": null,
        "updated_at": "2021-11-23T14:38:04Z",
        "updated_in_db_at": "2021-11-23T14:38:04Z"
      }
    },
    {
      "id": "1efc2700-8608-4ae3-9931-d8dac82b49ae",
      "type": "users",
      "attributes": {
        "created_at": "2021-11-23T14:38:04Z",
        "first_name": "Paulette",
        "last_name": null,
        "updated_at": "2021-11-23T14:38:04Z",
        "updated_in_db_at": "2021-11-23T14:38:04Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 3,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [User]

Description An array of User Objects

User [GET]

User [GET]

Request

Endpoint

GET /api/v2/account_lists/a4b5cfc1-eba5-4c99-9ddd-ec184f7c115f/users/432eab73-0472-4b83-b11c-b8f474173c63
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "432eab73-0472-4b83-b11c-b8f474173c63",
    "type": "users",
    "attributes": {
      "created_at": "2021-11-23T14:38:04Z",
      "first_name": "Tommye",
      "last_name": null,
      "updated_at": "2021-11-23T14:38:04Z",
      "updated_in_db_at": "2021-11-23T14:38:04Z"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

first_name

Type string

Description First Name

last_name

Type string

Description Last Name

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

User [DELETE]

User [DELETE]

Request

Endpoint

DELETE /api/v2/account_lists/502b5de5-2869-4e42-9307-ec77e4a666d9/users/cdf009db-d978-4e62-9a80-2be4521fad91
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body