contacts

Overview

This query returns a list of contacts for this account.

Special Considerations

• Does not take any input

Inputs

N/A

Returns

Promise<ContactsList>

A promise containing the ContactsList object.

ContactsList contains the inbound and outbound arrays, each of which contains the email and account of contacts.

Example

Running this query:

query {
  contacts {
    inbound {
      email
      account {
        accountType
        displayName
        currency
        slug
      }
    }
    outbound {
      email
      account {
        accountType
        displayName
        currency
        slug
      }
    }
  }
}

Gives us:

{
  "data": {
    "contacts": {
      "inbound": [
        {
          "email": "alex@getborderless.com",
          "account": {
            "accountType": "BUSINESS",
            "displayName": "Alex-Test",
            "currency": "USD"
            "slug": "US-Alex"
          }
        },
        ...
      ],
      "outbound": [
        ...
      ]
    }
  }
}

Common Errors

N/A