Account Lists

Account Lists Documentation

Account List [LIST]

Account List [LIST]

Request

Endpoint

GET /api/v2/organizations/account_lists
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

name

Type Unknown

Description sort by account list name

Required No

Filters

organization_id

Type ID string

Description filter where account list has a designation account belonging to an organization; Accepts IDs separated by comma

Required No

wildcard_search

Type string

Description filter where account list by user's/coach's first name, last name, email, by the account list name, or by the invite recipient email

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "e821b584-52ff-456b-a692-bd2c46c7b966",
      "type": "account_lists",
      "attributes": {
        "created_at": "2022-01-12T17:18:28Z",
        "name": "Wilderman LLC",
        "updated_at": "2022-01-12T17:18:28Z",
        "updated_in_db_at": "2022-01-12T17:18:28Z"
      },
      "relationships": {
        "account_list_users": {
          "data": [

          ]
        },
        "account_list_coaches": {
          "data": [

          ]
        },
        "account_list_invites": {
          "data": [

          ]
        },
        "designation_accounts": {
          "data": [
            {
              "id": "cba65f7a-1499-4284-bdb3-ec138c0aad8d",
              "type": "designation_accounts"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [AccountList]

Description An array of account lists

Account List [GET]

Account List [GET]

Request

Endpoint

GET /api/v2/organizations/account_lists/42ee090f-221c-4896-8ece-7269dbe14270
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "42ee090f-221c-4896-8ece-7269dbe14270",
    "type": "account_lists",
    "attributes": {
      "created_at": "2022-01-12T17:18:28Z",
      "name": "Wisoky-Wilkinson",
      "updated_at": "2022-01-12T17:18:28Z",
      "updated_in_db_at": "2022-01-12T17:18:28Z"
    },
    "relationships": {
      "account_list_users": {
        "data": [

        ]
      },
      "account_list_coaches": {
        "data": [

        ]
      },
      "account_list_invites": {
        "data": [

        ]
      },
      "designation_accounts": {
        "data": [
          {
            "id": "ef0f0b34-be5a-4c31-8c09-18f9008a7f08",
            "type": "designation_accounts"
          }
        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

name

Type string

Description name of the account list

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.

Relationships

account_list_coaches.data

Type ["AccountListCoach"]

Description collection of account_list_coaches

account_list_invites.data

Type ["AccountListInvite"]

Description collection of account_list_invites that are active and have not already been accepted

account_list_users.data

Type ["AccountListUser"]

Description collection of account_list_users

designation_accounts.data

Type ["AccountListUser"]

Description collection of designation_accounts