Skip to main content

View Customer

View a specific customer.

Endpoint​

GET /api/customers/{id}

Request​

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

Parameters​

ParameterTypeDescription
idintegerThe unique identifier of the customer to view

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"
          }
        ]
      },
      {
        "id": 52,
        "user_id": 231,
        "location": 3,
        "type": 1,
        "name": "Search test1",
        "key": "search_test",
        "description": null,
        "placeholder": "1",
        "fields": {
          "options": [
            null
          ],
          "fileConfig": null
        },
        "group": "b0fca735-7ee4-47b1-b4cc-5707fe7551fb",
        "created_at": "2025-07-28T05:51:08.000000Z",
        "updated_at": "2025-07-30T14:18:16.000000Z",
        "custom_field_values": [
          {
            "id": 79,
            "owner_id": 231,
            "user_id": 237,
            "custom_field_id": 52,
            "value": "Search test2",
            "created_at": "2025-07-28T05:51:28.000000Z",
            "updated_at": "2025-07-29T12:16:51.000000Z"
          }
        ]
      },
      {
        "id": 68,
        "user_id": 231,
        "location": 3,
        "type": 5,
        "name": "Birthday",
        "key": "birthday",
        "description": null,
        "placeholder": null,
        "fields": {
          "options": [
            "January",
            "March"
          ],
          "fileConfig": null
        },
        "group": "2015b8ab-986a-4392-bd23-aa551215f0b5",
        "created_at": "2025-08-09T21:23:24.000000Z",
        "updated_at": "2025-08-09T21:23:24.000000Z",
        "custom_field_values": [
          {
            "id": 126,
            "owner_id": 231,
            "user_id": 237,
            "custom_field_id": 68,
            "value": "January",
            "created_at": "2025-08-26T02:45:02.000000Z",
            "updated_at": "2025-09-15T14:32:46.000000Z"
          }
        ]
      }
    ],
    "notes": [
      {
        "id": 1064,
        "description": "Pre-live Test3 posted the note",
        "note": "helloo",
        "event": "note",
        "subject_id": 237,
        "subject_type": "customer",
        "subject_title": "Mark Twen",
        "caused_by": "Pre-live Test3",
        "created_at": "2025-08-26T02:45:42.000000Z"
      }
    ],
    "activity_log": [
      {
        "id": 531,
        "description": "Pre-live Test sent the proposal",
        "event": "sent",
        "subject_id": 55,
        "subject_type": "proposal",
        "subject_title": "New Proposal",
        "caused_by": "Pre-live Test3",
        "created_at": "2025-07-23T12:12:06.000000Z"
      },
      {
        "id": 533,
        "description": "Pre-live Test sent the contract",
        "event": "sent",
        "subject_id": 56,
        "subject_type": "contract",
        "subject_title": "New Contract 1",
        "caused_by": "Pre-live Test3",
        "created_at": "2025-07-23T12:14:39.000000Z"
      },
      {
        "id": 548,
        "description": "Pre-live Test sent the invoice",
        "event": "sent",
        "subject_id": 109,
        "subject_type": "invoice",
        "subject_title": "New Invoice",
        "caused_by": "Pre-live Test3",
        "created_at": "2025-07-23T13:09:26.000000Z"
      }
    ],
    "permissions": {
      "4": "view-invoice",
      "8": "view-contract",
      "12": "view-proposal",
      "16": "view-meeting"
    }
  }
}

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
notesarrayArray of notes for the customer
activity_logarrayArray of activity log entries
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

Notes Structure​

FieldTypeDescription
idintegerUnique identifier for the note
descriptionstringDescription of the note action
notestringThe note content
eventstringType of event (e.g., "note")
subject_idintegerID of the subject
subject_typestringType of subject (e.g., "customer")
subject_titlestringTitle of the subject
caused_bystringUser who created the note
created_atdatetimeWhen the note was created

Activity Log Structure​

FieldTypeDescription
idintegerUnique identifier for the activity
descriptionstringDescription of the activity
eventstringType of event (e.g., "sent")
subject_idintegerID of the subject
subject_typestringType of subject (e.g., "proposal", "contract", "invoice")
subject_titlestringTitle of the subject
caused_bystringUser who performed the action
created_atdatetimeWhen the activity occurred

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
404Customer not found
500Server Error
Last updated on