Get customers - Fieldinsight Public API

Request

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location 'https://app.fieldinsight.com/public-api//customers/?cursor=cD0yMDI0LTA3LTE1VDA5OjAwOjAwWg%3D%3D&page_size=50&order=name_asc&id=4001&email=dispatch%40hvac.example.com&external_id=CUST-1001&business_name=Northwind%20HVAC%20Services'

Responses

🟢200OK

application/json

Successful response.

Bodyapplication/json

Example

{
    "objects": [
        {
            "id": "4001",
            "external_id": "CUST-1001",
            "business_name": "Northwind HVAC Services",
            "business_number": "12 345 678 901",
            "mobile_number": "+61 412 345 678",
            "email": "dispatch@hvac.example.com",
            "notes": "Preferred HVAC contractor for all sites.",
            "address": "12 Cooling Way, Brisbane QLD 4000",
            "status": {
                "id": "string",
                "external_id": "string",
                "name": "string"
            },
            "payment_term": {
                "id": "string",
                "external_id": "string",
                "name": "string"
            },
            "custom_fields": [
                {
                    "field_type": "text",
                    "id": "1",
                    "name": "Service Agreement",
                    "value": "Premium"
                }
            ]
        }
    ],
    "next_page_cursor": "string",
    "prev_page_cursor": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠422Parameter Error

🟠429