In this section · 6 articles

Core API endpoints

A map of the endpoints Core 12.8 serves, grouped by area, with the credential, write access and rate limit each needs, plus where to find each module's API reference.

Applies to
Core 12.8 and later
Who can do this
Developer
On this page

All paths are under your Laramin's address, such as https://crm.example.com. For request and response details of every endpoint on your own installation, open Developer Tools › API Documentation. See How the Laramin API works.

Credential in the tables:

  • None: no credential needed.
  • App key: the platform API key or an API consumer key, unless someone is signed in. See Authenticate API requests.
  • Mobile token: a mobile access token or a personal API token. Write means a personal API token, which is read-only, is refused.
  • Web token: a token from POST /api/v1/web/login.

Every request also counts against the general limit of 60 a minute. See API rate limits.

Discovery

MethodPathCredentialWhat it does
GET
/api/version
NoneThe API versions served, minimum app versions and deprecations.

Mobile: signing in and signing up

See Sign people in from a mobile app and Let people sign up from a mobile app.

MethodPathCredentialLimitWhat it does
POST
/api/v1/mobile/login
NoneSign-inSigns in with an email address, username or phone number and a password. Returns an access token and a refresh token, or a two-factor challenge.
POST
/api/v1/mobile/login/two-factor
NoneTwo-factorFinishes a sign-in with the authenticator code or a recovery code. Returns the token pair.
POST
/api/v1/mobile/refresh
NoneToken refreshTrades a refresh token for a new pair.
POST
/api/v1/mobile/logout
Mobile tokenNo limit of its ownRevokes the access token sent and its refresh token.
POST
/api/v1/mobile/password/forgot
NonePassword resetEmails a 6-digit reset code.
POST
/api/v1/mobile/password/reset
NonePassword resetSets a new password with the code.
POST
/api/v1/mobile/register
NoneSign-upCreates an account, when sign-up from the app is allowed.
GET
/api/v1/mobile/registration/status
Sign-up sessionNo limit of its ownWhether the new account's address is verified yet.
POST
/api/v1/mobile/registration/verify
Sign-up sessionVerificationChecks the emailed code and returns the token pair.
POST
/api/v1/mobile/registration/exchange
Sign-up sessionNo limit of its ownReturns the token pair once the address is verified.
POST
/api/v1/mobile/registration/resend
Sign-up sessionSign-up code resendSends the verification email again.
POST
/api/v1/mobile/registration/abandon
Sign-up sessionNo limit of its ownDiscards the sign-up session.

Mobile: the signed-in person

See Mobile API endpoints.

MethodPathCredentialWhat it does
GET
/api/v1/mobile/profile
Mobile tokenThe signed-in person's profile.
POST
/api/v1/mobile/profile
Mobile token, writeChanges their name and language.
POST
/api/v1/mobile/profile/avatar
Mobile token, writeUploads their photo.
DELETE
/api/v1/mobile/profile/avatar
Mobile token, writeRemoves their photo.
POST
/api/v1/mobile/password
Mobile token, write; sign-in limitChanges their password, with the current one.
GET
/api/v1/mobile/notifications
Mobile tokenTheir in-app notifications, newest first, in pages.
POST
/api/v1/mobile/notifications/read-all
Mobile token, writeMarks all as read.
POST
/api/v1/mobile/notifications/{id}/read
Mobile token, writeMarks one as read.
GET
/api/v1/mobile/consent
Mobile tokenTheir consent choices, and any they still owe.
POST
/api/v1/mobile/consent
Mobile token, writeRecords their consent choices.
GET
/api/v1/mobile/workspaces
Mobile tokenThe workspaces they may work in, with time zones and office hours.
GET
/api/v1/mobile/authorization
Mobile tokenWhat they may do in the workspace and team the request runs in.

Mobile: app configuration

MethodPathCredentialWhat it does
GET
/api/v1/mobile/sync/manifest
App key, or a mobile tokenWhat the app should fetch again, so it can skip what hasn't changed.
GET
/api/v1/mobile/assets
/api/v1/mobile/assets/{key}
App keyImages and files the app uses, such as logos, by key.
GET
/api/v1/mobile/module/coremobile/…
App key, or a mobile tokenCore Mobile's settings, theme, menus, onboarding and dashboard. See How Core Mobile works.
GET
/api/v1/mobile/get_setting
App keyDeprecated. Core's public settings, in an older row format, for older apps. Don't build on it: use GET /api/v1/public/settings.

Public: website data

No credential. See Paging, filtering, sorting and caching.

MethodPathLimitWhat it does
GET
/api/v1/public/settings
PublicThe settings a website may show, in groups: site, company, theme, consent and uploads. Never passwords or keys.
GET
/api/v1/public/settings/{group}
PublicOne group.
GET
/api/v1/public/reference
Public readThe reference lists available.
GET
/api/v1/public/reference/{resource}
Public readOne list, in pages: countries (filter iso_code, phone_code), states (filter country_id), cities (filter state_id), currencies (filter code), plus languages with the Language add-on. Search with q. Only active entries.
GET
/api/v1/public/reference/{resource}/{id}
Public readOne entry.
GET
/api/v1/public/static-fields
/api/v1/public/static-fields/{code}
/api/v1/public/static-fields/{code}/options
/api/v1/public/static-options/{code}
Public readThe fixed option lists your Laramin and its modules use, such as statuses, with labels, colors and icons. See Manage static fields and options.

Countries, states and cities are managed in Currencies and locations.

A website calling these from visitors' browsers must be on your Laramin's list of allowed origins, set by whoever runs the server (CORS_ALLOWED_ORIGINS). By default only your Laramin's own address is allowed.

Web

In 12.7 and 12.8 the token from POST /api/v1/web/login isn't accepted: the endpoints below that need a web token answer it with 401 UNAUTHENTICATED. For an integration, use a personal API token on the mobile endpoints. See Authenticate API requests.

MethodPathCredentialWhat it does
POST
/api/v1/web/login
NoneSigns in with email and password. Returns data.user and data.token. From Core 12.8.7, an address your IP rules refuse for the account gets 403 UNAUTHORIZED ("Access denied from your network address. Please contact your administrator."), before the password is checked, and no token.
POST
/api/v1/web/register
NoneCreates an account with name, email and password, if Allow public registration is on in Security settings. While it's off, it answers 403 ("Account creation is not available on this app.") and creates nothing. From Core 12.8.7, an address your global IP rules refuse gets 403 UNAUTHORIZED ("Access denied from your network address. Please contact your administrator.") and creates nothing.
GET
/api/v1/web/profile
Web tokenThe signed-in person.
GET
/api/v1/web/users
Web token, and List User (feature.core.user.list)Users the person may see, in pages. Filters name, email, id; sorts name, email, created_at; search q.
GET
/api/v1/web/tokens
Web tokenThe signed-in person, with their web tokens.
GET
/api/v1/web/get_setting
Web tokenAn older endpoint that doesn't return settings. For countries, use GET /api/v1/public/reference/countries instead.
POST
/api/v1/web/logout
Web tokenEnds the web token.

Other Core endpoints

MethodPathCredentialWhat it does
GET
/api/v1/customfield/schema/{alias}
Mobile tokenAn entity's custom field definitions, such as user. See Custom field types and settings.
GET
/api/v1/help/me
Help Center tokenUsed by the Help Center to learn who's signing in. Not for integrations. See Connect to the Help Center.

Module APIs

Each module documents its own endpoints. A module's endpoints exist only while it's turned on.

ModuleEndpointsReference
Headless CMS/api/v1/public/hcms/…Delivery API reference
Blog/api/v1/public/blog/…Blog public API reference
SEO/api/v1/public/seo/…How SEO works and How the sitemap and feeds work
Monetization/api/v1/web/module/monetization/…, /api/v1/mobile/module/monetization/…Monetization catalogue API reference
Social Login/api/v1/public/sociallogin/…, /api/v1/mobile/module/sociallogin/…Social sign-in from a mobile app
Core Mobile/api/v1/mobile/module/coremobile/…How Core Mobile works
Language/api/v1/public/reference/languagesLanguage fields and permissions
Activity Log/api/v1/web/module/activitylog/logs/…, /api/v1/mobile/module/activitylog/logs/…No reference yet. The mobile endpoints return the signed-in person's own entries; the web ones, the entries they may see.
Property CRM/api/v1/public/propertycrm/…No reference yet: published properties, filters and locations, and the website inquiry form.
Webhook EngineSends to you, not called by youWebhook payloads, headers and events