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

Commit 571cd2e

Browse files
committed
Update timestamp query documentation
Timestamp based querying has been added to almost all of the customer API endpoints.
1 parent ff19145 commit 571cd2e

10 files changed

Lines changed: 18 additions & 32 deletions

File tree

source/customers/index.html.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ language_tabs: # must be one of https://git.io/vQNgJ
77

88
includes:
99
- intro
10+
- customers/intro
1011
- customers/auth
1112
- customers/company
1213
- customers/clients
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Querying by timestamp
2+
3+
Endpoints that retrieve multiple records support querying data by timestamps, unless otherwise specified.
4+
5+
Parameter | Description
6+
--------- | -----------
7+
min_created_at | Query records created after the specified date time.
8+
max_created_at | Query records created before the specified date time.
9+
min_updated_at | Query records updated after the specified date time.
10+
max_updated_at | Query records updated before the specified date time.
11+
12+
**Note**: You can pass a date or a date time to the timestamp queries. For example:
13+
`2023-7-28` or `2023-7-28 15:33:33 -700` or `2023-7-28T15:33:33-700`. The time defaults to `00:00:00` when not included, and the timezone defaults to UTC.

source/includes/customers/_labor_programs.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,3 @@ Parameter | Description
3535
--------- | -----------
3636
office_id | Labor programs belonging to the specified office
3737
page | A specific page of results.
38-
min_created_at | Query results created after the specified date time.
39-
max_created_at | Query results created before the specified date time.
40-
min_updated_at | Query results updated after the specified date time.
41-
max_updated_at | Query results updated before the specified date time.

source/includes/customers/_products.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,6 @@ model | Filter results by model name <small> must be an exact match</small>
104104
currency_code | Filter results by currency code. _e.g CAD_. <small>defaults to USD</small>
105105
query | Filter results by matching across manufacturer and model names <small>does not need to match exactly</small> <br/> _e.g. Shure SM57_
106106
page | A specific page of results.
107-
min_created_at | Query products created after the specified date time.
108-
max_created_at | Query products created before the specified date time.
109-
min_updated_at | Query products updated after the specified date time.
110-
max_updated_at | Query products updated before the specified date time.
111107

112108
If filtering with the `query` param, then it takes precedence, and the other filtering params are ignored. Can be used when unsure about the exact manufacturer or model name.
113109

source/includes/customers/_projects.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -118,18 +118,10 @@ It includes any shared projects, and only lists the active version (if multiple
118118
Parameter | Description
119119
--------- | -----------
120120
page | A specific page of results.
121-
min_created_at | Query projects created after the specified date time.
122-
max_created_at | Query projects created before the specified date time.
123-
min_updated_at | Query projects updated after the specified date time.
124-
max_updated_at | Query projects updated before the specified date time.
125121
active | (true/false) returns projects in an active stage when true; otherwise returns projects in non-active stages
126122
stage | Filter projects by stage (a single stage name or a comma separated list - param is ignored when active param is present)
127123
query | Filter by project name, custom_id, city, clients company name, clients first or last name
128124

129-
**Note**: You can pass a date or a date time to the timestamp queries. For example:
130-
`2023-7-28` or `2023-7-28 15:33:33 -700` or `2023-7-28T15:33:33-700`. The time defaults to
131-
`00:00:00` when not included, and the timezone defaults to UTC.
132-
133125
## Get a project
134126

135127
<%= shell_example('/projects/<ID>') %>

source/includes/customers/_purchase_orders.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,6 @@ Parameter | Description
4848
--------- | -----------
4949
page | A specific page of results.
5050
project_id | an optional project id to filter by
51-
min_created_at | Query purchase orders created after the specified date time.
52-
max_created_at | Query purchase orders created before the specified date time.
53-
min_updated_at | Query purchase orders updated after the specified date time.
54-
max_updated_at | Query purchase orders updated before the specified date time.
5551

5652
## Get a purchase order
5753

source/includes/customers/_service_cases.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,6 @@ This endpoint retrieves all of your service cases.
4444
Parameter | Description
4545
--------- | -----------
4646
page | A specific page of results.
47-
min_created_at | Query service cases created after the specified date time.
48-
max_created_at | Query service cases created before the specified date time.
49-
min_updated_at | Query service cases updated after the specified date time.
50-
max_updated_at | Query service cases updated before the specified date time.
51-
52-
**Note**: You can pass a date or a date time to the timestamp queries. For example:
53-
`2023-7-28` or `2023-7-28 15:33:33 -700` or `2023-7-28T15:33:33-700`. The time defaults to
54-
`00:00:00` when not included, and the timezone defaults to UTC.
5547

5648
## Get a service case
5749

source/includes/customers/projects/_discussions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,5 @@ Parameter | Description
4545
--------- | -----------
4646
PROJECT_ID | The ID of the project
4747
page | A specific page of results.
48+
49+
**Note**: Timestamp-based queries are not supported by this endpoint.

source/includes/customers/projects/_proposals.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,5 @@ Parameter | Description
5050
PROJECT_ID | The ID of the project
5151
page | A specific page of results
5252
expiry_public_link | if set to `true` a public link is generated that expires after 5 minutes
53-
min_created_at | Get proposals created after the specified date time.
54-
max_created_at | Get proposals created before the specified date time.
55-
min_updated_at | Get proposals updated after the specified date time.
56-
max_updated_at | Get proposals updated before the specified date time.
5753
min_view_date | Get proposals that had views after the specified date time.
5854
max_view_date | Get proposals that had views before the specified date time.

source/includes/customers/projects/_purchasing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,5 @@ Parameter | Description
5959
--------- | -----------
6060
PROJECT_ID | The ID of the project
6161
page | A specific page of line item results
62+
63+
**Note**: Timestamp-based queries are not supported by this endpoint.

0 commit comments

Comments
 (0)