Clients API

A client is an organisation the team does projects for: its names, its primary contact, where it works from and where the relationship stands. A project names its client through client_id, so the client exists first; a client with a project, archived or deleted ones included, is archived rather than deleted, so a project never loses the client it was done for.

The reads here see the clients of the token's team; a client guest sees only the clients of the projects they were invited to. A client outside that set is a 404 RESOURCE_NOT_FOUND, never a 403, so the API cannot be used to learn that a client exists. Every write runs the same action the Clients page runs, under the team permissions, and announces itself as a client.* event.

EndpointsCopy Anchor Link

Related

Projects APIThe engagements done for a client, filtered by client_id.Teams APIThe team a client belongs to.Activity APIWhat changed on a client and who did it.client.* eventsThe lifecycle of a client: creation, edits, archiving, restoring and deletion.