List Customer

Available Filter

Value Type	Example
date	2010-02-02T20:23:05+07:00

Operator Type	Description
gte	Greater Than or Equal
gt	Greater Than
lte	Lower Than or Equal
lt	Lower Than
eq	Equal
in	Inside some of values

Field Type	Value Type
id	uuid
created_on	date
updated_on	date

Example Filter

Field Type	Operator	Value
id	in	('uuid1' 'uuid2' 'uuid3')
created_on	lt	2023-02-02T20:13:05+07:00
updated_on	gt	2022-02-02T20:23:05+07:00

Available Sort

Operator Type	Description
asc	Smallest to Largest
desc	Largest to Smallest

Field	Description	Example
name	Customer Name	name asc
marketing_user.name	Customer Marketing Name	marketing_user.name asc
industry_category	Customer Industry Category	industry_category desc
email	Customer Email	email asc
created_on	Customer Created At	created_on desc
updated_on	Customer Updated At	updated_on desc

Available Search

Field	Example
name	Cherely Quin
marketing_user.name	Aaron James
industry_category	Technologies
email	customer@mail.com

Query Parameters

filters string[]
limit integer required

Possible values: >= 1

page integer required

Possible values: >= 1

search string
sorts string[]

Responses

• 200
• 400
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

data object
ids array
paginated_result object[]
Array [
email string
id string
industry_category object
name string
marketing_user object
id integer
name string
name string
npwp string
]
metadata object
count integer
page integer
total_count integer
total_page integer

{
  "data": {
    "ids": [
      null
    ],
    "paginated_result": [
      {
        "email": "string",
        "id": "string",
        "industry_category": {
          "name": "string"
        },
        "marketing_user": {
          "id": 0,
          "name": "string"
        },
        "name": "string",
        "npwp": "string"
      }
    ]
  },
  "metadata": {
    "count": 0,
    "page": 0,
    "total_count": 0,
    "total_page": 0
  }
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors
message string

{
  "errors": {},
  "message": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors
message string

{
  "errors": {},
  "message": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors
message string

{
  "errors": {},
  "message": "string"
}

Not Found

Loading...