Account

Schema

Name	Type	Description
customer_id	Integer	A serial ID assigned to the account, if coming from the legacy system, this will match the id from that system.
id	ULID	Unique identifier for the account.
inserted_at	String(format:datetime)	Timestamp when the account was created.
legacy_access	Boolean	Whether or not the account has access to the legacy APIs.
lrn_access	Boolean	Whether or not the account is allowed to utilize LRN APIs.
mms_access	Coverage Access Flag	Flag indicating MMS access level.
name	String	The canonical name of the account.
require_ip_api_access	Boolean	Whether or not Allowed Access IPs are required to access standard APIs.
require_ip_gql_access	Boolean	Whether or not Allowed Access IPs are required to access GQL APIs. Note: This will also affect user access to any associated dashboards.
sms_access	Coverage Access Flag	Flag indicating SMS access level.
updated_at	String(format:datetime)	Timestamp when the account was last updated.

Examples

Create Sub Account

Creates a new sub account under the current user’s account.

Request:

POST /api/v1/accounts HTTP/1.1
Accept: application/json, text/plain
Content-Type: application/json
Content-Length: 64
Authorization: Bearer ABC123

{
  "data": {
    "name": "ACME Corp"
  },
  "type": "account"
}

Response:

HTTP/1.1 201
Content-Type: application/json
Content-Length: 402

{
  "data": {
    "customer_id": 0,
    "id": "01J0CRVTXX9KBD9NWS02R5R8RT",
    "inserted_at": "2024-06-14T00:00:00.000000Z",
    "legacy_access": false,
    "lrn_access": false,
    "mms_access": "NONE",
    "name": "ACME Corp",
    "require_ip_api_access": false,
    "require_ip_gql_access": false,
    "sms_access": "NONE",
    "updated_at": "2024-06-14T00:00:00.000000Z"
  },
  "type": "account"
}

List Accounts

Lists all accounts associated with the parent account (including itself).

Request:

GET /api/v1/accounts HTTP/1.1
Accept: application/json, text/plain
Authorization: Bearer ABC123

Response:

HTTP/1.1 200
Content-Type: application/json
Content-Length: 673

{
  "data": {
    "items": [
      {
        "data": {
          "customer_id": 0,
          "id": "01J0CRVTXX9KBD9NWS02R5R8RT",
          "inserted_at": "2024-06-14T00:00:00.000000Z",
          "legacy_access": false,
          "lrn_access": false,
          "mms_access": "NONE",
          "name": "ACME Corp",
          "require_ip_api_access": false,
          "require_ip_gql_access": false,
          "sms_access": "NONE",
          "updated_at": "2024-06-14T00:00:00.000000Z"
        },
        "type": "account"
      }
    ],
    "page_info": {
      "after": "string",
      "before": "string",
      "limit": 0.0,
      "total": 0.0
    }
  },
  "type": "list"
}

Get Account

Retrieve a specific account by its ID.

Request:

GET /api/v1/accounts/{id} HTTP/1.1
Accept: application/json, text/plain
Authorization: Bearer ABC123

Response:

HTTP/1.1 201
Content-Type: application/json
Content-Length: 402

{
  "data": {
    "customer_id": 0,
    "id": "01J0CRVTXX9KBD9NWS02R5R8RT",
    "inserted_at": "2024-06-14T00:00:00.000000Z",
    "legacy_access": false,
    "lrn_access": false,
    "mms_access": "NONE",
    "name": "ACME Corp",
    "require_ip_api_access": false,
    "require_ip_gql_access": false,
    "sms_access": "NONE",
    "updated_at": "2024-06-14T00:00:00.000000Z"
  },
  "type": "account"
}