Users

Users Documentation

User [LIST]

User [LIST]

Request

Endpoint

GET /api/v2/account_lists/1216566c-640c-4526-83c4-c38513bd85e2/users
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "4f401557-a209-4cb3-ab0a-ad6cb0c2a181",
      "type": "users",
      "attributes": {
        "created_at": "2022-01-12T17:18:29Z",
        "first_name": "Prince",
        "last_name": null,
        "updated_at": "2022-01-12T17:18:29Z",
        "updated_in_db_at": "2022-01-12T17:18:29Z"
      }
    },
    {
      "id": "f0cb8218-b459-4a99-b30b-5aad540512be",
      "type": "users",
      "attributes": {
        "created_at": "2022-01-12T17:18:29Z",
        "first_name": "Keesha",
        "last_name": null,
        "updated_at": "2022-01-12T17:18:29Z",
        "updated_in_db_at": "2022-01-12T17:18:29Z"
      }
    },
    {
      "id": "5da79ddf-d99b-4b8b-9d78-d8d560727c82",
      "type": "users",
      "attributes": {
        "created_at": "2022-01-12T17:18:29Z",
        "first_name": "Cristopher",
        "last_name": null,
        "updated_at": "2022-01-12T17:18:29Z",
        "updated_in_db_at": "2022-01-12T17:18:29Z"
      }
    }
  ],
  "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/a0fd693c-54bc-4616-b8cf-dec96c514a5b/users/cb87e4ce-a5d4-4dc4-aab9-8eb02c24246f
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "cb87e4ce-a5d4-4dc4-aab9-8eb02c24246f",
    "type": "users",
    "attributes": {
      "created_at": "2022-01-12T17:18:30Z",
      "first_name": "Silvia",
      "last_name": null,
      "updated_at": "2022-01-12T17:18:30Z",
      "updated_in_db_at": "2022-01-12T17:18:30Z"
    }
  }
}

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/b1aea771-950b-483c-84e1-16fdd2ad18af/users/8dd83399-d20d-42cf-a845-b87ad297acbb
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body