Account and company
Sign in, find out who the token belongs to, read the details of the company the user works in, and check which version of the API is running.
Paths are relative to https://api.rushhourapp.com/api/v1. See the API reference overview for how to read each entry.
Sign-in
| Method | Path | Summary |
|---|---|---|
POST | /Auth/Login | Authenticates a user and returns a JWT token. |
POST /Auth/Login
Authenticates a user and returns a JWT token.
Required access: none — no token is needed.
Request body: LoginRequest (JSON).
Response: envelope; data is string.
Signed-in user
| Method | Path | Summary |
|---|---|---|
GET | /App/User | Get the signed-in user and the company they are working in. |
GET | /App/UserData | Get the signed-in user, with additional profile data, and the company they are working in. |
GET /App/User
Get the signed-in user and the company they are working in.
Response: envelope; data is CompanyUser.
GET /App/UserData
Get the signed-in user, with additional profile data, and the company they are working in.
Response: envelope; data is CompanyUser.
Company
| Method | Path | Summary |
|---|---|---|
GET | /Company/Info | Get the details of the company the signed-in user is working in. |
GET | /Company/UserToCompanies | List the companies the signed-in user belongs to. |
GET /Company/Info
Get the details of the company the signed-in user is working in.
Response: envelope; data is Company.
GET /Company/UserToCompanies
List the companies the signed-in user belongs to.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ItemsPerPage | query | integer (int32) | No | |
Page | query | integer (int32) | No | |
SearchTerm | query | string | No | |
SortBy | query | string | No | |
SortDirection | query | integer (int32) | No | One of: 0 (Ascending), 1 (Descending). |
Response: envelope; data is CompanyDtoPagedList.
Version
| Method | Path | Summary |
|---|---|---|
GET | /Settings/Version | Get the version of the API that is running. |
GET /Settings/Version
Get the version of the API that is running.
Required access: none — no token is needed.
Response: envelope; data has no documented shape.