---
title: "Get Customers"
method: GET
path: "/customers"
tags: ["customers"]
---

# Get Customers

`GET /customers`

Retrieve all existing customers that were created via this API. Customers created through APIv3 (http://production.brickworksoftware.com/api_docs/) are not included.

## Query parameters

- `id` string[]
- `firstName` string
- `lastName` string
- `email` string
- `mock` boolean
- `perPage` integer
- `pageAfter` string
- `order` 'asc' | 'desc'
- `orderBy` string

## Response `200`

Return an array of data responses

- object
  - `data` CustomerDataResponse[], required — Array of data response objects
    - `type` string — Type of resource
    - `id` string, uuid — UUID of resource; additional resource attributes will also be returned
    - `attributes` object — Attributes of resource
      - `firstName` string — First name of the customer
      - `lastName` string — Last name of the customer
      - `email` string — Customer's email address
      - `organizationCustomerId` string — Organization's own ID for customer
      - `phoneNumber` string — Customer's phone number
      - `customerNotes` string — Notes about the customer
      - `locale` string — Locale of the customer
      - `createdAt` string, date-time — Date the resource was logged
      - `updatedAt` string, date-time — Date the resource was last modified
      - `createdBy` string, uuid — User who created the customer resource
      - `updatedBy` union — User who updated the customer resource
        - string, uuid
        - unknown
    - `relationships` CustomerRelationships — Relationships of a customer
      - `organization` OrganizationRelationship, required — Organization that the resource belongs to
        - `data` object
          - `type` string — Type of the organization
          - `id` string, uuid — UUID of the organization
    - `links` Link — Link object for resource meta data
      - `self` string
  - `links` Pagination, required
    - `self` string, required — Link to current page of data response
    - `next` string — Link to next page of data response

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/brickworksoftware/apis/brickwork-software-api.md) · [All operations](https://skmtc.dev/brickworksoftware/apis/brickwork-software-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/brickworksoftware/brickwork-software-api/revisions/b06aa4f3b83c/schema)