entities

Graphql fields and variables for the entities query

Scope required: admin:read

For a complete list of possible response fields see the EntityConnection type.

query entities ($after: String, $before: String, $first: Int, $last: Int, $filter: String, $sort: String, $viewId: ID, $format: String) {
  entities (after: $after, before: $before, first: $first, last: $last, filter: $filter, sort: $sort, viewId: $viewId, format: $format) {
    edges {
      cursor
      node {
        abbreviation
        accentColor
        baseCurrencyId
        billingCity
        billingCountry
        billingState
        billingStreet
        billingZip
        brandColor
        createdAt
        customerServiceEmail
        emailSenderName
        emailTemplate
        fax
        fiscalYearStartMonth
        id
        invoiceNumberPrefix
        invoiceNumberSeq
        invoicesImageUrl
        isDefault
        name
        phone
        privacyUrl
        quoteNumberPrefix
        quoteNumberSeq
        quotesImageUrl
        refundPolicyUrl
        taxId
        termsUrl
        timezone
        topNavImageUrl
        tzIdentifier
        tzOffset
        updatedAt
        website
      }
    }
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasNextPage
      hasPreviousPage
    }
  }
}

Arguments

Name	Type	Description
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
filter	String
sort	String
viewId	ID
format	String

Response

• EntityConnection