Skip to main content

View All Customers

View all customers.

Endpoint

GET /api/customers

Request

GET https://app.getmanageit.io/api/customers
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Response

{
"data": [
{
"id": 237,
"name": "Mark",
"last_name": "Twen",
"phone": "5627143119",
"profile_photo_path": "https://getmanageit.s3.us-east-2.amazonaws.com/images/profile_photo_path/1756176301_919596075.png",
"email": "[email protected]",
"stripe_customer_flag": false,
"business_information": {
"company_name": null,
"company_phone": null,
"company_email": null,
"company_website": null,
"address_1": null,
"address_2": null,
"country": null,
"city": null,
"state": null,
"zip_code": null,
"fax": "333"
},
"custom_fields": [
{
"id": 54,
"user_id": 231,
"location": 3,
"type": 7,
"name": "q",
"key": "q",
"description": null,
"placeholder": null,
"fields": {
"options": [
"234"
],
"fileConfig": null
},
"group": "c5cd8947-93a8-4f22-bfed-d7dc45657afb",
"created_at": "2025-07-29T12:32:45.000000Z",
"updated_at": "2025-07-29T12:32:45.000000Z",
"custom_field_values": [
{
"id": 82,
"owner_id": 231,
"user_id": 237,
"custom_field_id": 54,
"value": "234",
"created_at": "2025-07-29T12:34:30.000000Z",
"updated_at": "2025-09-15T14:32:27.000000Z"
}
]
},
{
"id": 55,
"user_id": 231,
"location": 3,
"type": 9,
"name": "jpg",
"key": "jpg",
"description": null,
"placeholder": null,
"fields": {
"options": [
null
],
"fileConfig": {
"acceptFile": [
"DOCX/DOC"
],
"allowMultiple": false,
"maxFiles": 0
}
},
"group": "3482b1a7-95a1-41e4-bd08-5604a4d5b51d",
"created_at": "2025-07-29T12:33:04.000000Z",
"updated_at": "2025-07-29T12:34:48.000000Z",
"custom_field_values": [
{
"id": 83,
"owner_id": 231,
"user_id": 237,
"custom_field_id": 55,
"value": [
{
"name": "unnamed (2).jpg",
"path": "https://getmanageit.s3.us-east-2.amazonaws.com/custom-fields/1753792470_744716117.jpg"
}
],
"created_at": "2025-07-29T12:34:30.000000Z",
"updated_at": "2025-07-29T12:34:30.000000Z"
}
]
}
],
"permissions": {
"4": "view-invoice",
"8": "view-contract",
"12": "view-proposal",
"16": "view-meeting"
}
},
{
"id": 292,
"name": "John",
"last_name": "Smithers",
"phone": "5627143119",
"profile_photo_path": null,
"email": "[email protected]",
"stripe_customer_flag": true,
"business_information": {
"company_name": null,
"company_phone": "123",
"company_email": null,
"company_website": null,
"address_1": null,
"address_2": null,
"country": null,
"city": null,
"state": null,
"zip_code": null,
"fax": null
},
"custom_fields": [...],
"permissions": []
}
]
}

Response Fields

FieldTypeDescription
idintegerUnique identifier for the customer
namestringCustomer's first name
last_namestringCustomer's last name
phonestringCustomer's phone number
profile_photo_pathstring/nullURL to customer's profile photo
emailstringCustomer's email address
stripe_customer_flagbooleanWhether customer has Stripe integration
business_informationobjectCustomer's business details
custom_fieldsarrayArray of custom fields for the customer
permissionsobjectCustomer's permissions for different modules

Business Information Fields

FieldTypeDescription
company_namestring/nullCompany name
company_phonestring/nullCompany phone number
company_emailstring/nullCompany email address
company_websitestring/nullCompany website URL
address_1string/nullPrimary address line
address_2string/nullSecondary address line
countrystring/nullCountry
citystring/nullCity
statestring/nullState/Province
zip_codestring/nullPostal/ZIP code
faxstring/nullFax number

Custom Fields Structure

FieldTypeDescription
idintegerUnique identifier for the custom field
user_idintegerID of the user who created the field
locationintegerField location identifier
typeintegerField type (1=text, 5=select, 7=text, 9=file)
namestringDisplay name of the field
keystringUnique key for the field
descriptionstring/nullField description
placeholderstring/nullPlaceholder text
fieldsobjectField configuration options
groupstringField group identifier
created_atdatetimeWhen the field was created
updated_atdatetimeWhen the field was last updated
custom_field_valuesarrayArray of values for this customer

Custom Field Values Structure

FieldTypeDescription
idintegerUnique identifier for the field value
owner_idintegerID of the field owner
user_idintegerID of the customer
custom_field_idintegerID of the custom field
valuemixedThe field value (string, array, etc.)
created_atdatetimeWhen the value was created
updated_atdatetimeWhen the value was last updated

Permissions Structure

The permissions object contains key-value pairs where:

  • Key: Permission ID (integer as string)
  • Value: Permission name (string)

Common permissions include:

  • "4": "view-invoice"
  • "8": "view-contract"
  • "12": "view-proposal"
  • "16": "view-meeting"

Status Codes

CodeDescription
200Success
401Unauthorized
500Server Error