Get Customer Locations

GET

/crm/customers/%7Bcustomer_id%7D/locations

GET

/crm/customers/%7Bcustomer_id%7D/locations

1 curl -G https://https//https/crm/customers/%7Bcustomer_id%7D/locations \
2      -H "{{tenant_key_name}}: {{tenant_key_value1}}|{{tenant_key_value2}}" \
3      --data-urlencode include=services,contacts \
4      --data-urlencode sort=is_primary,-created_at \
5      -d page=1 \
6      -d per_page=10

20005 CRM_Customers_Customer Location Management_Get Customer Locations_example

1 {
2   "data": [
3     {
4       "id": "f6d39cb8-e8c2-4d78-aee9-54d479f5e933",
5       "audit": {
6         "created_at": "2025-09-15T20:19:33.000000Z",
7         "created_by": 31,
8         "updated_at": "2025-09-15T20:19:33.000000Z",
9         "updated_by": 31
10       },
11       "flags": {
12         "is_billing_address": false,
13         "is_primary_location": false
14       },
15       "access": {
16         "instructions": "Use side gate, key under mat",
17         "parking_instructions": "Park in driveway"
18       },
19       "status": "active",
20       "address": {
21         "city": "Anytown",
22         "state": "CA",
23         "line_1": "123 Main Street",
24         "line_2": "Apt 4B",
25         "country": "US",
26         "postal_code": "90210"
27       },
28       "service": {},
29       "customer": {
30         "id": 1,
31         "display_name": "Jane Doe",
32         "customer_type": "residential"
33       },
34       "property": {
35         "type": "house",
36         "is_owned": true,
37         "occupancy_type": "owner_occupied"
38       },
39       "seasonal": {},
40       "conditions": {
41         "dog_on_premises": false
42       },
43       "coordinates": {
44         "latitude": 34.0901,
45         "longitude": -118.4065
46       },
47       "customer_id": "d76970a0-3655-43a0-95cf-934949a8445e",
48       "location_type": "residential",
49       "contacts_count": 0,
50       "services_count": 0,
51       "created_by_user": {
52         "id": 31,
53         "name": "Propel Admin",
54         "email": "admin@propelhub.com"
55       },
56       "updated_by_user": {
57         "id": 31,
58         "name": "Propel Admin",
59         "email": "admin@propelhub.com"
60       },
61       "work_orders_count": 0,
62       "customer_projects_count": 0
63     },
64     {
65       "id": "257be142-3790-48fd-8aa0-4fc1090b901d",
66       "audit": {
67         "created_at": "2025-09-15T20:18:33.000000Z",
68         "created_by": 31,
69         "updated_at": "2025-09-15T20:18:33.000000Z",
70         "updated_by": 31
71       },
72       "flags": {
73         "is_billing_address": false,
74         "is_primary_location": false
75       },
76       "access": {
77         "instructions": "Use side gate, key under mat",
78         "parking_instructions": "Park in driveway"
79       },
80       "status": "active",
81       "address": {
82         "city": "Anytown",
83         "state": "CA",
84         "line_1": "123 Main Street",
85         "line_2": "Apt 4B",
86         "country": "US",
87         "postal_code": "90210"
88       },
89       "service": {},
90       "customer": {
91         "id": 1,
92         "display_name": "Jane Doe",
93         "customer_type": "residential"
94       },
95       "property": {
96         "type": "house",
97         "is_owned": true,
98         "occupancy_type": "owner_occupied"
99       },
100       "seasonal": {},
101       "conditions": {
102         "dog_on_premises": false
103       },
104       "coordinates": {
105         "latitude": 34.0901,
106         "longitude": -118.4065
107       },
108       "customer_id": "d76970a0-3655-43a0-95cf-934949a8445e",
109       "location_type": "residential",
110       "contacts_count": 0,
111       "services_count": 0,
112       "created_by_user": {
113         "id": 31,
114         "name": "Propel Admin",
115         "email": "admin@propelhub.com"
116       },
117       "updated_by_user": {
118         "id": 31,
119         "name": "Propel Admin",
120         "email": "admin@propelhub.com"
121       },
122       "work_orders_count": 0,
123       "customer_projects_count": 0
124     },
125     {
126       "id": "777eafbd-c01b-49c0-a42f-0027a31e3b9a",
127       "audit": {
128         "created_at": "2025-09-15T20:14:50.000000Z",
129         "created_by": 31,
130         "updated_at": "2025-09-15T20:14:50.000000Z",
131         "updated_by": 31
132       },
133       "flags": {
134         "is_billing_address": false,
135         "is_primary_location": false
136       },
137       "access": {
138         "instructions": "Use side gate, key under mat",
139         "parking_instructions": "Park in driveway"
140       },
141       "status": "active",
142       "address": {
143         "city": "Anytown",
144         "state": "CA",
145         "line_1": "123 Main Street",
146         "line_2": "Apt 4B",
147         "country": "US",
148         "postal_code": "90210"
149       },
150       "service": {},
151       "customer": {
152         "id": 1,
153         "display_name": "Jane Doe",
154         "customer_type": "residential"
155       },
156       "property": {
157         "type": "string",
158         "is_owned": true,
159         "occupancy_type": "owner_occupied"
160       },
161       "seasonal": {},
162       "conditions": {
163         "dog_on_premises": false
164       },
165       "coordinates": {
166         "latitude": 34.0901,
167         "longitude": -118.4065
168       },
169       "customer_id": "d76970a0-3655-43a0-95cf-934949a8445e",
170       "location_type": "residential",
171       "contacts_count": 0,
172       "services_count": 0,
173       "created_by_user": {
174         "id": 31,
175         "name": "Propel Admin",
176         "email": "admin@propelhub.com"
177       },
178       "updated_by_user": {
179         "id": 31,
180         "name": "Propel Admin",
181         "email": "admin@propelhub.com"
182       },
183       "work_orders_count": 0,
184       "customer_projects_count": 0
185     }
186   ],
187   "meta": {
188     "to": 3,
189     "from": 1,
190     "path": "http://127.0.0.1:8001/v1/crm/customers/d76970a0-3655-43a0-95cf-934949a8445e/locations",
191     "type": "customer_location_collection",
192     "links": [
193       {
194         "label": "&laquo; Previous",
195         "active": false
196       },
197       {
198         "label": "1",
199         "active": true,
200         "url": null,
201         "page": null
202       },
203       {
204         "label": "Next &raquo;",
205         "active": false
206       }
207     ],
208     "total": 3,
209     "version": "1.0",
210     "per_page": 10,
211     "last_page": 1,
212     "customer_id": {
213       "id": 1,
214       "uuid": "d76970a0-3655-43a0-95cf-934949a8445e",
215       "status": "active",
216       "last_name": "Doe",
217       "tenant_id": 4,
218       "created_at": "2025-09-12T19:47:41.000000Z",
219       "created_by": 31,
220       "first_name": "Jane",
221       "updated_at": "2025-09-12T19:48:01.000000Z",
222       "updated_by": 31,
223       "do_not_call": false,
224       "do_not_text": false,
225       "credit_limit": "5000.00",
226       "display_name": "Jane Doe",
227       "do_not_email": false,
228       "credit_status": "good",
229       "customer_type": "residential",
230       "priority_level": "standard",
231       "current_balance": "0.00",
232       "marketing_opt_out": false,
233       "preferred_language": "en",
234       "customer_portal_access": true,
235       "tenant_customer_location_id": 1
236     },
237     "total_count": 3,
238     "current_page": 1,
239     "generated_at": "2025-09-15T20:50:06.583132Z"
240   },
241   "links": {
242     "last": "http://127.0.0.1:8001/v1/crm/customers/d76970a0-3655-43a0-95cf-934949a8445e/locations?page=1",
243     "self": "http://127.0.0.1:8001/v1/crm/customers/d76970a0-3655-43a0-95cf-934949a8445e/locations",
244     "first": "http://127.0.0.1:8001/v1/crm/customers/d76970a0-3655-43a0-95cf-934949a8445e/locations?page=1",
245     "customer": "http://127.0.0.1:8001/v1/crm/customers/1"
246   },
247   "stats": {
248     "flags": {
249       "with_dogs": 0,
250       "with_hazards": 0,
251       "owned_properties": 3,
252       "rented_properties": 0,
253       "with_access_codes": 0
254     },
255     "by_type": {
256       "billing": 0,
257       "mailing": 0,
258       "primary": 0,
259       "service": 0,
260       "shipping": 0,
261       "secondary": 0
262     },
263     "seasonal": {
264       "total_seasonal": 0,
265       "currently_active": 0
266     },
267     "by_status": {
268       "active": 3,
269       "inactive": 0,
270       "seasonal": 0,
271       "pending_verification": 0
272     },
273     "by_property_type": {
274       "mixed_use": 0,
275       "commercial": 0,
276       "industrial": 0,
277       "residential": 0,
278       "vacant_land": 0
279     },
280     "service_coverage": {
281       "unassigned": 3,
282       "unique_zones": 0,
283       "assigned_to_zones": 0
284     }
285   },
286   "summary": {
287     "coverage": {
288       "cities": 1,
289       "states": [
290         "CA"
291       ],
292       "service_zones": 0
293     },
294     "has_coordinates": 3,
295     "total_locations": 3
296   }
297 }

Retrieve all locations associated with a specific customer. Supports filtering by location type, status, geographic area, and includes pagination. Use include parameter to load related services, contacts, and equipment data.

Query parameters

includestringOptional

Optional: Include related data (services,contacts,equipment)

sortstringOptional

Optional: Sort order (created_at,-updated_at,is_primary,city,state)

pageintegerOptional

Optional: Page number for pagination

per_pageintegerOptional

Optional: Items per page (max 100)

Response headers

Hoststring

X-Powered-Bystring

Cache-Controlstring

Response

datalist of objects

metaobject

linksobject

statsobject

summaryobject

Headers

Query parameters

Response headers

Response