companies

A paginated list of companies in the shop. Company objects are business entities that purchase from the merchant.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the companies action (under Companies).
Fill in the fields below, then reference the result from later steps as {{companies.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Companies($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: CompanySortKeys, $query: String) {
  companies(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        contactCount
        contactsCount
        createdAt
        customerSince
        defaultCursor
        defaultRole
        externalId
        hasTimelineComment
        id
        lifetimeDuration
        locationsCount
        mainContact
        name
        note
        ordersCount
        totalSpent
        updatedAt
      }
    }
    nodes {
      contactCount
      contactsCount {
        count
        precision
      }
      createdAt
      customerSince
      defaultCursor
      defaultRole {
        id
        name
        note
      }
      externalId
      hasTimelineComment
      id
      lifetimeDuration
      locationsCount {
        count
        precision
      }
      mainContact {
        company
        createdAt
        customer
        id
        isMainContact
        lifetimeDuration
        locale
        title
        updatedAt
      }
      name
      note
      ordersCount {
        count
        precision
      }
      totalSpent {
        amount
        currencyCode
      }
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list by the given key.

One ofCREATED_ATIDNAMEORDER_COUNTSINCE_DATETOTAL_SPENTUPDATED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` | | active_customers_count | integer | | created_at | time | | external_id | id | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about [querying by metafield value](https://shopify.dev/apps/build/custom-data/metafields/query-by-metafield-value). | | | - `metafields.custom.on_sale:true`<br/> - `metafields.product.material:"gid://shopify/Metaobject/43458085"` | | name | string | | ordering_status | string | | since_date | time | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "CREATED_AT",
  "query": "string"
}

Response

Read the result with {{companies.response.data.data.companies}}. If the API returns errors, the step fails and they are at {{companies.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

contactCountobject

contactsCountobject

createdAtobject

customerSinceobject

defaultCursorobject

defaultRoleobject

externalIdobject

hasTimelineCommentobject

idobject

lifetimeDurationobject

locationsCountobject

mainContactobject

nameobject

noteobject

ordersCountobject

totalSpentobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?