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
| Method | Path | Credential | What it does |
|---|---|---|---|
| GET | /api/ | None | The 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.
| Method | Path | Credential | Limit | What it does |
|---|---|---|---|---|
| POST | /api/ | None | Sign-in | Signs 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/ | None | Two-factor | Finishes a sign-in with the authenticator code or a recovery code. Returns the token pair. |
| POST | /api/ | None | Token refresh | Trades a refresh token for a new pair. |
| POST | /api/ | Mobile token | No limit of its own | Revokes the access token sent and its refresh token. |
| POST | /api/ | None | Password reset | Emails a 6-digit reset code. |
| POST | /api/ | None | Password reset | Sets a new password with the code. |
| POST | /api/ | None | Sign-up | Creates an account, when sign-up from the app is allowed. |
| GET | /api/ | Sign-up session | No limit of its own | Whether the new account's address is verified yet. |
| POST | /api/ | Sign-up session | Verification | Checks the emailed code and returns the token pair. |
| POST | /api/ | Sign-up session | No limit of its own | Returns the token pair once the address is verified. |
| POST | /api/ | Sign-up session | Sign-up code resend | Sends the verification email again. |
| POST | /api/ | Sign-up session | No limit of its own | Discards the sign-up session. |
Mobile: the signed-in person
See Mobile API endpoints.
| Method | Path | Credential | What it does |
|---|---|---|---|
| GET | /api/ | Mobile token | The signed-in person's profile. |
| POST | /api/ | Mobile token, write | Changes their name and language. |
| POST | /api/ | Mobile token, write | Uploads their photo. |
| DELETE | /api/ | Mobile token, write | Removes their photo. |
| POST | /api/ | Mobile token, write; sign-in limit | Changes their password, with the current one. |
| GET | /api/ | Mobile token | Their in-app notifications, newest first, in pages. |
| POST | /api/ | Mobile token, write | Marks all as read. |
| POST | /api/ | Mobile token, write | Marks one as read. |
| GET | /api/ | Mobile token | Their consent choices, and any they still owe. |
| POST | /api/ | Mobile token, write | Records their consent choices. |
| GET | /api/ | Mobile token | The workspaces they may work in, with time zones and office hours. |
| GET | /api/ | Mobile token | What they may do in the workspace and team the request runs in. |
Mobile: app configuration
| Method | Path | Credential | What it does |
|---|---|---|---|
| GET | /api/ | App key, or a mobile token | What the app should fetch again, so it can skip what hasn't changed. |
| GET | /api//api/ | App key | Images and files the app uses, such as logos, by key. |
| GET | /api/ | App key, or a mobile token | Core Mobile's settings, theme, menus, onboarding and dashboard. See How Core Mobile works. |
| GET | /api/ | App key | Deprecated. Core's public settings, in an older row format, for older apps. Don't build on it: use GET /api/. |
Public: website data
No credential. See Paging, filtering, sorting and caching.
| Method | Path | Limit | What it does |
|---|---|---|---|
| GET | /api/ | Public | The settings a website may show, in groups: site, company, theme, consent and uploads. Never passwords or keys. |
| GET | /api/ | Public | One group. |
| GET | /api/ | Public read | The reference lists available. |
| GET | /api/ | Public read | One 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/ | Public read | One entry. |
| GET | /api//api//api//api/ | Public read | The 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_). By default only your Laramin's own address is allowed.
Web
In 12.7 and 12.8 the token from POST /api/ 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.
| Method | Path | Credential | What it does |
|---|---|---|---|
| POST | /api/ | None | Signs 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/ | None | Creates 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/ | Web token | The signed-in person. |
| GET | /api/ | Web token, and List User (feature.) | Users the person may see, in pages. Filters name, email, id; sorts name, email, created_at; search q. |
| GET | /api/ | Web token | The signed-in person, with their web tokens. |
| GET | /api/ | Web token | An older endpoint that doesn't return settings. For countries, use GET /api/ instead. |
| POST | /api/ | Web token | Ends the web token. |
Other Core endpoints
| Method | Path | Credential | What it does |
|---|---|---|---|
| GET | /api/ | Mobile token | An entity's custom field definitions, such as user. See Custom field types and settings. |
| GET | /api/ | Help Center token | Used 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.
| Module | Endpoints | Reference |
|---|---|---|
| Headless CMS | /api/ | Delivery API reference |
| Blog | /api/ | Blog public API reference |
| SEO | /api/ | How SEO works and How the sitemap and feeds work |
| Monetization | /api/, /api/ | Monetization catalogue API reference |
| Social Login | /api/, /api/ | Social sign-in from a mobile app |
| Core Mobile | /api/ | How Core Mobile works |
| Language | /api/ | Language fields and permissions |
| Activity Log | /api/, /api/ | 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/ | No reference yet: published properties, filters and locations, and the website inquiry form. |
| Webhook Engine | Sends to you, not called by you | Webhook payloads, headers and events |
Thanks. That helps us decide what to write next.
Thanks for telling us what was missing.
You already answered for this article today. Thanks.
We got a lot of answers from your network just now. Try again in a few minutes.
We couldn't send that. Check your connection and try again.
Links in this article
Printed from help.laramin.in. The online article may have changed since.