List accounts of customer

GET

accounts

curl --request GET \
  --url https://api.togai.com/accounts \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "id": "G234DZZKBKACATFFGVGEMERFI",
      "name": "ACME Enterprise - Account2",
      "status": "ACTIVE",
      "aliases": [
        {
          "alias": "account2@acme.com",
          "status": "ACTIVE"
        },
        {
          "alias": "+1234567890",
          "status": "ARCHIVED"
        }
      ]
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
  "context": {
    "pageSize": 10
  }
}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

nextToken

string

pageSize

number

Response

200 - application/json

data

object[]

data.id

string

required

Identifier of the account

data.name

string

required

Name of the Account

data.customerId

string

required

Identifier of the customer

data.invoiceCurrency

string

required

ISO_4217 code of the currency in which the account must be invoiced Defaults to Base currency.

data.aliases

object[]

list of aliases of the account

data.address

object

billing address of the customer

data.primaryEmail

string

Primary email of the customer

data.status

enum<string>

required

Status of the account

Available options:

ACTIVE,

ARCHIVED

data.settings

object[]

data.invoiceGroupDetails

object

Invoice group details

data.metadata

object

Additional information associated with the account. Example: GSTN, VATN

nextToken

string

context

object

Update a customer Create an account

curl --request GET \
  --url https://api.togai.com/accounts \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "id": "G234DZZKBKACATFFGVGEMERFI",
      "name": "ACME Enterprise - Account2",
      "status": "ACTIVE",
      "aliases": [
        {
          "alias": "account2@acme.com",
          "status": "ACTIVE"
        },
        {
          "alias": "+1234567890",
          "status": "ARCHIVED"
        }
      ]
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
  "context": {
    "pageSize": 10
  }
}

Introduction

APIs

Authorizations

Query Parameters

Response