Endpoint Index
This is an index of all endpoints available in version 2 of the Momentum PM API.
New to the API? Please read the Getting started guide!
Client
Client configuration and visual branding.
| Endpoint | Description |
|---|---|
| /v2/client/configuration | Get client configuration and visual branding |
| /v2/client/{app}/{instance}/{theme}/manifest | Get client manifest file |
Auth
Authentication and onboarding.
| Endpoint | Description |
|---|---|
| /v2/auth | Sign-in |
| /v2/auth/logout | Sign-out |
| /v2/auth/reset | Account activation and password reset |
Actor
Basic information about an actor e.g. name, account and communication methods.
| Endpoint | Description |
|---|---|
| /v2/actor/status | Returns light weight information about an actor |
| /v2/actor | Returns detailed actor information |
| /v2/actor/account | Retrieve and update an actors account details |
| /v2/actor/role | Returns a list of current roles for an actor |
Notifications
Notification subscription management, e g handling unsubscribe links. | Endpoint | Description | |---------------------------------------------------------|-------------------------------------------------------------| |/v2/notifications/actor/read | Mark all or some of an loged in actors notifications as read. (PATCH) | |/v2/notifications/functions/{id} | List notification functions | |/v2/notifications/subscriptions/{id} | Get and change subscription status | |/v2/notifications/subscriptions/{id} | Update information for a specific subscription. (POST) |
Market
Marketplace for items such as rentable objects
| Endpoint | Description |
|---|---|
| /v2/market/objects | List of market objects |
| /v2/market/objects/{id} | A specific market object |
| /v2/market/objects/{id}/images/{fileId} | Stream an market object image |
| /v2/market/objects/{id}/status | Get the current user's status for a specific market object e.g. if the user can apply for the market object in question |
| /v2/market/objects/{id}/thumbnail | Stream an market object thumbnail image |
| /v2/market/objects/types/{id} | Retrieve information about a specific market object type |
| /v2/market/applicant | Get applicant information |
| /v2/market/applicant | Update applicant information |
| /v2/market/applicant/status | Get applicant status information such as registration information or a list of market object queues etc. |
| /v2/market/applicant/coApplicants | Get a list of active Co-Applicants including co-applicant requests for a signed in user |
| /v2/market/applicant/coApplicants/{id} | Respond to a Co-Applicant request i.e accept or refuse the request for a signed in user |
| /v2/market/applicant/profile | Get a signed in user's applicant profile (GET) |
| /v2/market/applicant/profile | Update a signed in user's applicant profile (PATCH) |
| /v2/market/applicant/profile/options | Returns applicant profile options |
| /v2/market/applications | Get a list of applications for the current user |
| /v2/market/{marketObjectId}/applications/{id} | Post command on an application item for a specific market object |
| /v2/market/{id}/applications | Post application command on specific ad |
| /v2/market/consents | Retrieves a list of user consent status items |
| /v2/market/objects/includes | Retrieve information about all the includes selectable for market objects. |
| /v2/market/subscriptions | Retrieves a list of user subscriptions on market objects |
| /v2/market/subscriptions | Returns a list of active market subscriptions on rental property ads for a logged in user |
| /v2/market/subscriptions/marketobjects/types | Returns a list of market object types for use when saving a subscription. |
| v2/market/subscriptions/{id} | Saves a new market subscription on rental property ads for a logged in user. |
| /v2/market/subscriptions/{id} | Deletes an existing market subscription on rental property ads for a logged in user. |
| /v2/market/objects/types/{id}/subscriptions/setting | Retrieve information about a specific market object type's subscription setting. |
Booking
View and book objects such as laundry facilities.
| Endpoint | Description |
|---|---|
| /v2/booking/objects | Get a list of bookable objects |
| /v2/booking/objects/{bookingObjectId}/link | Get a link to to the bookable object |
Contracts
Lists and create contracts.
| Endpoint | Description |
|---|---|
| /v2/contracts | Retrieve a list of contracts for a specific user via their account |
| /v2/contracts/{id} | A specific contract |
| /v2/contracts/types | Retrieve a specific user's contract types via their account i.e. user must be logged in |
| /v2/contracts/{id}/report | Retrieve digital copy of the contract |
| /v2/contracts/{id} | Create a contract (PUT) |
| /v2/contracts/{id}/notice/contracts | Retrieve a list of any contracts to notice that has a relationship with the contract. |
| /v2/contracts/{id}/notice | Retrieve information about the possibility to create a notice for a contract for a logged in user. |
| /v2/contracts/{contractId}/notice/options | Returns all the options needed for creating a succesfull notice for a contract e.g. |
| /v2/contracts/{contractId}/notice/options | Returns all the options needed for creating a succesfull notice for a contract e.g. |
| /v2/contracts/{contractId}/notice/{id} | Creates a new temporary notice. |
| /v2/contracts/{id}/notice | Deletes an ongoing notice (DELETE). |
Customers
Lists and create/update customers.
| Endpoint | Description |
|---|---|
| /v2/customers | Retrieve a list of customers |
| /v2/customers/{id} | Get a specific customer |
| /v2/customers/{id} | Create a customer (PUT) |
| /v2/customers/{id} | Update a customer (PATCH) |
Errands
Errands and errand configuration.
| Endpoint | Description |
|---|---|
| /v2/errands/types | Get available errand types (order, disturbance, contact) |
| /v2/errands/graph | Get a structural path for making a errand. |
| /v2/errands/graph/configuration/entry | Get configuration info for a graph errands path about entry to the object (keys, pets) |
| /v2/errands/graph/configuration/fault | Get configuration info for a graph errands path necessary to report a fault (list of fault descriptions) |
Payment
Information how to use a specific payment method for a ledger note. For now only Swish
| Endpoint | Description |
|---|---|
| /v2/payment/swish | Creates an Swish request for paying a ledger note |
| /v2/payment/swish/{id} | Getting status for an Swish request |
Signings
Lists a logged in users signings.
| Endpoint | Description |
|---|---|
| /v2/signings | Retrieve a list of signings for a specific user via their account |
| /v2/signings/{id} | A specific signing |