Developers
ChangelogSupportcoevera.comGet API keys
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

ConceptsGlossary: UI and API names

Glossary: UI and API names

View as Markdown/concepts/glossary.mdOpen in ClaudeAsk Claude about this pageOpen in ChatGPTAsk ChatGPT about this page

The names the Coevera app shows next to the names the API uses, for the entities and fields whose names differ, and why integrations key on API names.

Answer

The app and the API name several things differently: users are Clients, roles are MasterRights, documents are CloudObjects, messages are Memos, sales units are SalesUnits and product line items are OpptyProductRelations. Admins can rename entities and fields in the app; the API names stay, so integrations key on API names and look labels up when they need them.

These docs give the API name first and the app's name in bold on first use: owner_id (shown in the app as Owner). This table is for the other direction: you know a screen in the app and need the entity behind it.

Entities

In the app In the API (REST path, GraphQL repository)
User Clients, client
Role MasterRights, masterRight
Sales Unit (Unit) SalesUnits, salesUnit
Document CloudObjects, cloudObject; attached to records through CloudObjectRelations
Folder (of documents) CloudObjectFolders, cloudObjectFolder
Message Memos, memo; its comments are MemoComments
Note Notes, note
Email Emails, email
Text Message TextMessages, textMessage
Product Line Item OpptyProductRelations, opptyProductRelation
Opportunity Opportunities, opportunity; IDs that may point at a lead or an opportunity are lead_oppty_id
Step (of a pipeline or a process) Steps, step
Step sales activities StepChecklists, stepChecklist
Velocity Timeframes, timeframe
Field Auto Number FieldSequences, fieldSequence
Recurrence OpptyRecurrences and TaskRecurrences
Dropdown options Data, data
Space The space ID in every URL, {space_id}

The app files administration of users and roles under Administration › Units, Users & Roles, and API applications under Units, Users & Roles › Applications.

Fields

In the app In the API
Owner owner_id (the ID), owner (the related record)
Sales unit unit_id, unit
Role (of a user) master_right_id on Clients
A user's e-mail email on Clients; records use email1 to email5
A record's phone phone1 to phone5
Custom fields cf_ plus the field's name at creation, such as cf_customer_tier

Renamed entities and fields

An admin can rename entities such as Accounts, Contacts, Leads, Opportunities, Projects and Quotes, and any field, so the labels in one space differ from another's. The API names do not follow:

  • entity_name on /entities/Entities is the stable name (Account), and name_singular and name_plural are the labels an admin set, or null while the default applies.
  • A field keeps its api_name when it is renamed. A field that is deleted and created again under the same name gets a new one, with a number added (cf_customer_tier1).

Key integrations on API names and read labels from those two endpoints when you show them. The fields page shows how.

Limits

Limit Details
Labels Per space: an admin's renames show in the app, never in API names
This table Covers the names that differ; an entity not listed here has the same name in both, such as Account and Accounts