Skip to content

[PEP-1898] Document ownerUserIds on company responses #1861

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.

Sign up for GitHub

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

Merged
Rob-Codat merged 2 commits into from
Jul 21, 2026
Merged

[PEP-1898] Document ownerUserIds on company responses #1861

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
250283c
[PEP-1898] Document ownerUserIds on company responses
Rob-Codat Jul 14, 2026
9fab418
[PEP-1898] Address PR feedback: active voice, drop changelog post
Rob-Codat Jul 14, 2026
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
6 changes: 6 additions & 0 deletions docs/using-the-api/managing-companies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,12 @@ res, err := platformClient.Companies.List(ctx, operations.ListCompaniesRequest{

</Tabs>

### View company owners

A company can have one or more owners — [users](/configure/user-management/adding-users) in Codat responsible for that company. Every company response includes a read-only `ownerUserIds` property that lists the IDs of the company's owners. If a company has no owners, `ownerUserIds` is an empty array.

You assign and manage owners in the Codat Portal. The [Create company](/platform-api#/operations/create-company) and [Update company](/platform-api#/operations/update-company) endpoints don't accept the `ownerUserIds` property in request bodies.

### Authorize access to company data

Once you've created the company, they'll need to give you permission to read their data from a given source, like their accounting software. There are several approaches to doing this, but for simplicity we've just covered our out-of-the-box [hosted link](/auth-flow/authorize-hosted-link) approach.
Expand Down
Loading