Skip to content
This repository was archived by the owner on May 19, 2026. It is now read-only.

Commit 3c17f1d

Browse files
committed
deploy: 571cd2e
1 parent 9590fde commit 3c17f1d

1 file changed

Lines changed: 36 additions & 104 deletions

File tree

customers/index.html

Lines changed: 36 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@
5656
<li>
5757
<a href="#pagination" class="toc-h2 toc-link" data-title="Pagination">Pagination</a>
5858
</li>
59+
<li>
60+
<a href="#querying-by-timestamp" class="toc-h2 toc-link" data-title="Querying by timestamp">Querying by timestamp</a>
61+
</li>
5962
</ul>
6063
</li>
6164
<li>
@@ -517,6 +520,35 @@ <h2 id='pagination'>Pagination</h2>
517520

518521
<p>The response also includes a <code>X-Total-Count</code> header, which is the total number of
519522
resources in the collection.</p>
523+
<h2 id='querying-by-timestamp'>Querying by timestamp</h2>
524+
<p>Endpoints that retrieve multiple records support querying data by timestamps, unless otherwise specified.</p>
525+
526+
<table><thead>
527+
<tr>
528+
<th>Parameter</th>
529+
<th>Description</th>
530+
</tr>
531+
</thead><tbody>
532+
<tr>
533+
<td>min_created_at</td>
534+
<td>Query records created after the specified date time.</td>
535+
</tr>
536+
<tr>
537+
<td>max_created_at</td>
538+
<td>Query records created before the specified date time.</td>
539+
</tr>
540+
<tr>
541+
<td>min_updated_at</td>
542+
<td>Query records updated after the specified date time.</td>
543+
</tr>
544+
<tr>
545+
<td>max_updated_at</td>
546+
<td>Query records updated before the specified date time.</td>
547+
</tr>
548+
</tbody></table>
549+
550+
<p><strong>Note</strong>: You can pass a date or a date time to the timestamp queries. For example:
551+
<code>2023-7-28</code> or <code>2023-7-28 15:33:33 -700</code> or <code>2023-7-28T15:33:33-700</code>. The time defaults to <code>00:00:00</code> when not included, and the timezone defaults to UTC.</p>
520552
<h1 id='authentication'>Authentication</h1>
521553
<blockquote>
522554
<p>Sample request with Authorization:</p>
@@ -1296,22 +1328,6 @@ <h3 id='url-parameters'>URL Parameters</h3>
12961328
<td>page</td>
12971329
<td>A specific page of results.</td>
12981330
</tr>
1299-
<tr>
1300-
<td>min_created_at</td>
1301-
<td>Query results created after the specified date time.</td>
1302-
</tr>
1303-
<tr>
1304-
<td>max_created_at</td>
1305-
<td>Query results created before the specified date time.</td>
1306-
</tr>
1307-
<tr>
1308-
<td>min_updated_at</td>
1309-
<td>Query results updated after the specified date time.</td>
1310-
</tr>
1311-
<tr>
1312-
<td>max_updated_at</td>
1313-
<td>Query results updated before the specified date time.</td>
1314-
</tr>
13151331
</tbody></table>
13161332
<h1 id='market-segments'>Market Segments</h1><h2 id='get-all-market-segments'>Get all market segments</h2><div class="highlight"><pre class="highlight shell tab-shell--json"><code>curl <span class="s2">"https://app.jetbuilt.com/api/market_segments"</span> <span class="se">\</span>
13171333
<span class="nt">-H</span> <span class="s2">"Authorization: Token token=YOURAPIKEY"</span> <span class="se">\</span>
@@ -1523,22 +1539,6 @@ <h3 id='url-parameters'>URL Parameters</h3>
15231539
<td>page</td>
15241540
<td>A specific page of results.</td>
15251541
</tr>
1526-
<tr>
1527-
<td>min_created_at</td>
1528-
<td>Query products created after the specified date time.</td>
1529-
</tr>
1530-
<tr>
1531-
<td>max_created_at</td>
1532-
<td>Query products created before the specified date time.</td>
1533-
</tr>
1534-
<tr>
1535-
<td>min_updated_at</td>
1536-
<td>Query products updated after the specified date time.</td>
1537-
</tr>
1538-
<tr>
1539-
<td>max_updated_at</td>
1540-
<td>Query products updated before the specified date time.</td>
1541-
</tr>
15421542
</tbody></table>
15431543

15441544
<p>If filtering with the <code>query</code> param, then it takes precedence, and the other filtering params are ignored. Can be used when unsure about the exact manufacturer or model name.</p>
@@ -2050,22 +2050,6 @@ <h3 id='url-parameters'>URL Parameters</h3>
20502050
<td>A specific page of results.</td>
20512051
</tr>
20522052
<tr>
2053-
<td>min_created_at</td>
2054-
<td>Query projects created after the specified date time.</td>
2055-
</tr>
2056-
<tr>
2057-
<td>max_created_at</td>
2058-
<td>Query projects created before the specified date time.</td>
2059-
</tr>
2060-
<tr>
2061-
<td>min_updated_at</td>
2062-
<td>Query projects updated after the specified date time.</td>
2063-
</tr>
2064-
<tr>
2065-
<td>max_updated_at</td>
2066-
<td>Query projects updated before the specified date time.</td>
2067-
</tr>
2068-
<tr>
20692053
<td>active</td>
20702054
<td>(true/false) returns projects in an active stage when true; otherwise returns projects in non-active stages</td>
20712055
</tr>
@@ -2078,10 +2062,6 @@ <h3 id='url-parameters'>URL Parameters</h3>
20782062
<td>Filter by project name, custom_id, city, clients company name, clients first or last name</td>
20792063
</tr>
20802064
</tbody></table>
2081-
2082-
<p><strong>Note</strong>: You can pass a date or a date time to the timestamp queries. For example:
2083-
<code>2023-7-28</code> or <code>2023-7-28 15:33:33 -700</code> or <code>2023-7-28T15:33:33-700</code>. The time defaults to
2084-
<code>00:00:00</code> when not included, and the timezone defaults to UTC.</p>
20852065
<h2 id='get-a-project'>Get a project</h2><div class="highlight"><pre class="highlight shell tab-shell--json"><code>curl <span class="s2">"https://app.jetbuilt.com/api/projects/&lt;ID&gt;"</span> <span class="se">\</span>
20862066
<span class="nt">-H</span> <span class="s2">"Authorization: Token token=YOURAPIKEY"</span> <span class="se">\</span>
20872067
<span class="nt">-H</span> <span class="s2">"Accept: application/vnd.jetbuilt.v1"</span> <span class="se">\</span>
@@ -3752,6 +3732,8 @@ <h3 id='url-parameters'>URL Parameters</h3>
37523732
<td>A specific page of results.</td>
37533733
</tr>
37543734
</tbody></table>
3735+
3736+
<p><strong>Note</strong>: Timestamp-based queries are not supported by this endpoint.</p>
37553737
<h1 id='project-proposals'>Project Proposals</h1><h2 id='get-proposals-in-your-project'>Get proposals in your project</h2><div class="highlight"><pre class="highlight shell tab-shell--json"><code>curl <span class="s2">"https://app.jetbuilt.com/api/projects/&lt;PROJECT_ID&gt;/proposals"</span> <span class="se">\</span>
37563738
<span class="nt">-H</span> <span class="s2">"Authorization: Token token=YOURAPIKEY"</span> <span class="se">\</span>
37573739
<span class="nt">-H</span> <span class="s2">"Accept: application/vnd.jetbuilt.v1"</span> <span class="se">\</span>
@@ -3817,22 +3799,6 @@ <h3 id='url-parameters'>URL Parameters</h3>
38173799
<td>if set to <code>true</code> a public link is generated that expires after 5 minutes</td>
38183800
</tr>
38193801
<tr>
3820-
<td>min_created_at</td>
3821-
<td>Get proposals created after the specified date time.</td>
3822-
</tr>
3823-
<tr>
3824-
<td>max_created_at</td>
3825-
<td>Get proposals created before the specified date time.</td>
3826-
</tr>
3827-
<tr>
3828-
<td>min_updated_at</td>
3829-
<td>Get proposals updated after the specified date time.</td>
3830-
</tr>
3831-
<tr>
3832-
<td>max_updated_at</td>
3833-
<td>Get proposals updated before the specified date time.</td>
3834-
</tr>
3835-
<tr>
38363802
<td>min_view_date</td>
38373803
<td>Get proposals that had views after the specified date time.</td>
38383804
</tr>
@@ -3912,6 +3878,8 @@ <h3 id='url-parameters'>URL Parameters</h3>
39123878
<td>A specific page of line item results</td>
39133879
</tr>
39143880
</tbody></table>
3881+
3882+
<p><strong>Note</strong>: Timestamp-based queries are not supported by this endpoint.</p>
39153883
<h1 id='project-service-packages'>Project Service Packages</h1><h2 id='get-all-service-packages-in-your-project'>Get all service packages in your project</h2><div class="highlight"><pre class="highlight shell tab-shell--json"><code>curl <span class="s2">"https://app.jetbuilt.com/api/projects/&lt;PROJECT_ID&gt;/service_packages"</span> <span class="se">\</span>
39163884
<span class="nt">-H</span> <span class="s2">"Authorization: Token token=YOURAPIKEY"</span> <span class="se">\</span>
39173885
<span class="nt">-H</span> <span class="s2">"Accept: application/vnd.jetbuilt.v1"</span> <span class="se">\</span>
@@ -4212,22 +4180,6 @@ <h3 id='url-parameters'>URL Parameters</h3>
42124180
<td>project_id</td>
42134181
<td>an optional project id to filter by</td>
42144182
</tr>
4215-
<tr>
4216-
<td>min_created_at</td>
4217-
<td>Query purchase orders created after the specified date time.</td>
4218-
</tr>
4219-
<tr>
4220-
<td>max_created_at</td>
4221-
<td>Query purchase orders created before the specified date time.</td>
4222-
</tr>
4223-
<tr>
4224-
<td>min_updated_at</td>
4225-
<td>Query purchase orders updated after the specified date time.</td>
4226-
</tr>
4227-
<tr>
4228-
<td>max_updated_at</td>
4229-
<td>Query purchase orders updated before the specified date time.</td>
4230-
</tr>
42314183
</tbody></table>
42324184
<h2 id='get-a-purchase-order'>Get a purchase order</h2><div class="highlight"><pre class="highlight shell tab-shell--json"><code>curl <span class="s2">"https://app.jetbuilt.com/api/purchase_orders/&lt;ID&gt;"</span> <span class="se">\</span>
42334185
<span class="nt">-H</span> <span class="s2">"Authorization: Token token=YOURAPIKEY"</span> <span class="se">\</span>
@@ -4352,27 +4304,7 @@ <h3 id='url-parameters'>URL Parameters</h3>
43524304
<td>page</td>
43534305
<td>A specific page of results.</td>
43544306
</tr>
4355-
<tr>
4356-
<td>min_created_at</td>
4357-
<td>Query service cases created after the specified date time.</td>
4358-
</tr>
4359-
<tr>
4360-
<td>max_created_at</td>
4361-
<td>Query service cases created before the specified date time.</td>
4362-
</tr>
4363-
<tr>
4364-
<td>min_updated_at</td>
4365-
<td>Query service cases updated after the specified date time.</td>
4366-
</tr>
4367-
<tr>
4368-
<td>max_updated_at</td>
4369-
<td>Query service cases updated before the specified date time.</td>
4370-
</tr>
43714307
</tbody></table>
4372-
4373-
<p><strong>Note</strong>: You can pass a date or a date time to the timestamp queries. For example:
4374-
<code>2023-7-28</code> or <code>2023-7-28 15:33:33 -700</code> or <code>2023-7-28T15:33:33-700</code>. The time defaults to
4375-
<code>00:00:00</code> when not included, and the timezone defaults to UTC.</p>
43764308
<h2 id='get-a-service-case'>Get a service case</h2><div class="highlight"><pre class="highlight shell tab-shell--json"><code>curl <span class="s2">"https://app.jetbuilt.com/api/service_cases/&lt;ID&gt;"</span> <span class="se">\</span>
43774309
<span class="nt">-H</span> <span class="s2">"Authorization: Token token=YOURAPIKEY"</span> <span class="se">\</span>
43784310
<span class="nt">-H</span> <span class="s2">"Accept: application/vnd.jetbuilt.v1"</span> <span class="se">\</span>

0 commit comments

Comments
 (0)