Read Accounts
GET
https://backend.test-hyegro.com/accounts/
Request
Query Params
skip
integer
Skip
Default:
0
limit
integer
Limit
Default:
20
search
Search
Any of
schema
Schema
Any of
Responses
🟢200OK
application/json
Body
array of:
name
Name
Any of
account_type
Account Type
Any of
industry
Industry
Any of
account_status
Account Status
Any of
annual_revenue
Annual Revenue
Any of
number_of_employees
Number Of Employees
Any of
website
Website
Any of
phone
Phone
Any of
mobile
Mobile
Any of
email
Email
Any of
currency
Currency
Any of
billing_address
Billing Address
Any of
billing_city
Billing City
Any of
billing_state
Billing State
Any of
billing_country
Billing Country
Any of
billing_postal_code
Billing Postal Code
Any of
shipping_address
Shipping Address
Any of
shipping_city
Shipping City
Any of
shipping_state
Shipping State
Any of
shipping_country
Shipping Country
Any of
shipping_postal_code
Shipping Postal Code
Any of
notes
Notes
Any of
manager_id
Manager Id
Any of
manager_name
Manager Name
Any of
created_by
Created By
Any of
updated_by
Updated By
Any of
created_by_name
Created By Name
Any of
updated_by_name
Updated By Name
Any of
fax
Fax
Any of
created_at
Created At
Any of
updated_at
Updated At
Any of
cf1
Cf1
Any of
cf2
Cf2
Any of
cf3
Cf3
Any of
cf4
Cf4
Any of
cf5
Cf5
Any of
cf6
Cf6
Any of
cf7
Cf7
Any of
cf8
Cf8
Any of
cf9
Cf9
Any of
cf10
Cf10
Any of
id
integer
Id
Example
[
{
"name": "string",
"account_type": "string",
"industry": "string",
"account_status": "string",
"annual_revenue": 0,
"number_of_employees": 0,
"website": "string",
"phone": "string",
"mobile": "string",
"email": "user@example.com",
"currency": "string",
"billing_address": "string",
"billing_city": "string",
"billing_state": "string",
"billing_country": "string",
"billing_postal_code": "string",
"shipping_address": "string",
"shipping_city": "string",
"shipping_state": "string",
"shipping_country": "string",
"shipping_postal_code": "string",
"notes": "string",
"manager_id": 0,
"manager_name": "string",
"created_by": 0,
"updated_by": 0,
"created_by_name": "string",
"updated_by_name": "string",
"fax": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cf1": "string",
"cf2": "string",
"cf3": "string",
"cf4": "string",
"cf5": "string",
"cf6": "string",
"cf7": "string",
"cf8": "string",
"cf9": "string",
"cf10": "string",
"id": 0
}
]
🟠422Parameter Error
Modified at 2025-04-15 14:01:56