Retrieving your Lumar accounts

To begin fully using the API you will need access to account with an active subcription.

To find out which accounts do you have access to you can run following GraphQL query.

Operation: query getMyAccounts { me { accounts(first: 5) { nodes { id name } } } }Response Example: { "data": { "me": { "username": "your.username@usually-email.com", "accounts": { "nodes": [ { "id": "TjAwN0FjY291bnQyMTkyMQ", "name": "Your Account Name" } ] } } } }

getMyAccountsTry in Explorer

GraphQL

query getMyAccounts {
  me {
    accounts(first: 5) {
      nodes {
        id
        name
      }
    }
  }
}

When you have an account id that you want to access to you can skip going through me and query directly to get a specific account.

Operation: query getAccountNode($accountId: ObjectID!) { node(id: $accountId) { ... on Account { id name } } }Variables: { "accountId": "TjAwN0FjY291bnQ3MTU" }Response Example: { "data": { "node": { "id": "TjAwN0FjY291bnQ3MTU", "name": "Your Account Name" } } }

getAccountNodeTry in Explorer

GraphQL

query getAccountNode($accountId: ObjectID!) {
  node(id: $accountId) {
    ... on Account {
      id
      name
    }
  }
}

or you can use getAccount query.

Operation: query getSpecificAccount($accountId: ObjectID!) { getAccount(id: $accountId) { ... on Account { id name } } }Variables: { "accountId": "TjAwN0FjY291bnQ3MTU" }Response Example: { "data": { "getAccount": { "id": "TjAwN0FjY291bnQ3MTU", "name": "Your Account Name" } } }

getSpecificAccountTry in Explorer

GraphQL

query getSpecificAccount($accountId: ObjectID!) {
  getAccount(id: $accountId) {
    ... on Account {
      id
      name
    }
  }
}

Seat limits

An account's subscription caps how many users may be connected to it. Two fields on Account report the numbers the API itself enforces:

usersLimit -- the maximum number of users the account may hold. This is 0 when the account's package sells no seats; 0 never means "unlimited".
usersCount -- the users currently connected to the account, which is what usersLimit is compared against. Pending user invites are not counted, so seats already promised to open invites still read as free.

Gate an "invite user" action on usersCount < usersLimit rather than deriving the limit from accountSettings: once the two numbers meet, connecting another user through the API fails with ACCOUNT_USER_LIMIT_REACHED.

Users provisioned by SSO login are added outside this check, so on an SSO account usersCount may exceed usersLimit. Read the remaining seats as max(0, usersLimit - usersCount).

Seat limits​

Seat limits