Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

REST APIUsers, roles, units and permissions

Users, roles, units and permissions

Users (Clients), sales units, sales roles, roles (MasterRights), profiles and API applications.

  • 23 entities
EntityOperationsSummary
Clients8Clients: list, get, create, update and delete, plus batch operations.
ClientExcludedOppties8ClientExcludedOppties: list, get, create, update and delete, plus batch operations.
ClientFavorites8ClientFavorites: list, get, create, update and delete, plus batch operations.
ClientSettings Read-only2Read-only: list and get ClientSettings.
ClientStoryReads8ClientStoryReads: list, get, create, update and delete, plus batch operations.
SalesUnits8SalesUnits: list, get, create, update and delete, plus batch operations.
SalesUnitClientRelations Read-only2Read-only: list and get SalesUnitClientRelations.
SalesRoles8SalesRoles: list, get, create, update and delete, plus batch operations.
MasterRights8MasterRights: list, get, create, update and delete, plus batch operations.
AllowedAccountTypes8AllowedAccountTypes: list, get, create, update and delete, plus batch operations.
AllowedAppointmentTypes8AllowedAppointmentTypes: list, get, create, update and delete, plus batch operations.
AllowedCompanyEmails8AllowedCompanyEmails: list, get, create, update and delete, plus batch operations.
AllowedCompanyPhones8AllowedCompanyPhones: list, get, create, update and delete, plus batch operations.
AllowedContactTypes8AllowedContactTypes: list, get, create, update and delete, plus batch operations.
AllowedLeadTypes8AllowedLeadTypes: list, get, create, update and delete, plus batch operations.
AllowedPipelines8AllowedPipelines: list, get, create, update and delete, plus batch operations.
AllowedQuoteTypes8AllowedQuoteTypes: list, get, create, update and delete, plus batch operations.
AllowedTaskTypes8AllowedTaskTypes: list, get, create, update and delete, plus batch operations.
Profiles Read-only2Read-only: list and get Profiles.
ProfileSharingClientRelations Read-only2Read-only: list and get ProfileSharingClientRelations.
ProfileSharingSalesUnitRelations Read-only2Read-only: list and get ProfileSharingSalesUnitRelations.
ProfileRelations8ProfileRelations: list, get, create, update and delete, plus batch operations.
ApiAccesses Read-only2Read-only: list and get ApiAccesses.

Indented entities are helpers of the entity above them: sharing, data-exchange and KPI relations.