# Read customers

**GET /customers**

Read a list of all customers, including their details, with pagination, or a subset of customers based on query parameters. Whether a customer is a company or a private person is controlled by "isCompany" flag property. The schemas are also slightly different for a company (no "person" property) or a person (no "organizationNumber").


## Servers
- https://rest.api.24sevenoffice.com/v1: https://rest.api.24sevenoffice.com/v1 ()


## Authentication methods
- Tfso


## Parameters
### Headers
- **Authorization** (string)
  Authorization header


### Query parameters
- **limit** (number(int32))

- **organizationNumber** (string)
  Filter customers by organization number.
- **isCompany** (boolean)
  A flag variable to filter customers by company or person.
- **isSupplier** (boolean)
  A flag variable to filter customers by being a supplier or not.
- **modifiedFrom** (string)
  Filter customers by date of last modification. Compares dates by greater or equal and accepts dates in ISO8601 format
- **createdFrom** (string)
  Filter customers by date created. Compares dates by greater or equal and accepts dates in ISO8601 format
- **sortBy** (string)
  Sort customers by field and direction. Takes in a pair of field and direction separated by a colon symbol ':'


## Responses
### 200
Ok
#### Headers
- **link** (string)
  The "link" header includes information on where to find `first`, `previous` and `next` page. Refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link
- **Access-Control-Allow-Origin** (string)

- **Access-Control-Allow-Credentials** (string)

- **X-Trace-Id** (string)


#### Body: application/json (array[object])
- **id** (integer(int32))
  A unique identifier for the customer within Finago Office CRM. This ID is used for reference and linking transactions to specific customers.
- **name** (string | null)
  A human-readable name or label for a customer, making it easily identifiable to users.
- **person** (object)
  The first and the last name of a customer if the customer is a person.
- **isCompany** (boolean)
  A flag variable indicating whether the customer is a company (true) or a person (false).
- **isSupplier** (boolean)
  A flag variable indicating whether the customer is also a supplier (true) or not (false).
- **organizationNumber** (string | null)
  The organization number issued by authorities, like a VAT number, of the customer if the customer is a company.
- **address** (object)
  Addresses for the customer.
- **email** (object)
  Email addresses for the customer.
- **phone** (string | null)
  A phone number for contacting the customer.
- **createdAt** (string)
  A timestamp for when a record was created, in ISO 8601 format.
- **modifiedAt** (string)
  A timestamp for when one of the properties of a record was last modified, in ISO 8601 format.

### 401
Unauthorized. Missing or invalid bearer token.
#### Headers
- **Access-Control-Allow-Origin** (string)

- **Access-Control-Allow-Credentials** (string)

- **X-Trace-Id** (string)



[Powered by Bump.sh](https://bump.sh)