From a607c90afa1772f805436df857932e2cb0651cbf Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:28:26 +0000 Subject: [PATCH] Update managing-companies.md --- docs/using-the-api/managing-companies.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/using-the-api/managing-companies.md b/docs/using-the-api/managing-companies.md index 90bbe6ee7..74bb302ec 100644 --- a/docs/using-the-api/managing-companies.md +++ b/docs/using-the-api/managing-companies.md @@ -107,7 +107,6 @@ if (companyCreatedRes.company().isPresent()) { ``` - :::caution Retain the company ID @@ -371,14 +370,13 @@ If you use include a `null` or empty `tags` object in the [Update company](/plat ::: -#### Filtering companies by metadata +#### Filter companies by metadata + +Once you have enriched the company with additional metadata in the form of tags, you can use it for filtering. This allows you to retrieve companies based on specific criteria, such as finding a specific company by customer ID or retrieving a group of companies that the same tag. -To filter companies by metadata, use the `tags` query parameter on the [List Companies](/platform-api#/operations/list-companies) endpoint. -This allows you to retrieve companies based on tags you’ve assigned, such as finding a specific company by customer ID or retrieving a group of companies sharing the same tag. -The tags query parameter uses the same query language as Codat's query parameter. -[Read more](/using-the-api/querying). +To do so, use the `tags` query parameter on the [List companies](/platform-api#/operations/list-companies) endpoint. The `tags` query parameter uses the same query language as Codat's query parameters. See more on querying in [Query data](/using-the-api/querying). -For example, to return a specific company by your customer ID: +Here is a query example that returns a specific company by a customer ID: