Skip to content

Update querying.md #1268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/using-the-api/querying.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,17 @@ Our `GET /{dataType}` endpoints typically return an array of items of that given

## Example queries

### Companies with connected platforms

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add: Query: platform != "" to align with the formatting of the rest of the page

<Tabs>
<TabItem value="http" label="HTTP">

```http
GET /companies/?query=platform!=""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume we need to encode this, so GET /companies/?query=platform%21%3d"" ?
Will the "" actually work like this?

```
</TabItem>
</Tabs>

### Invoices with amounts outstanding

Query: `amountDue > 0`
Expand Down
Loading