Skip to content

User Management API (v2)

Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/usersapi

Users

APIs to onboard and manage users.

Operations

Activate a user

Request

This endpoint activates a deactivated user.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/activate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Response
No content

Add favorite

Request

Add a favorite item for a user.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
typestringrequired

The type of favorite (e.g. "company", "legal_entity", "trip").

paramsobject

Key-value pairs of parameters for the favorite.

displayNamestringrequired

Display name for the favorite item.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/favorites \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "string",
    "params": {
      "property1": "string",
      "property2": "string"
    },
    "displayName": "string"
  }'

Responses

OK

Bodyapplication/json
favoriteobject(FavoriteItem)

A single favorite item.

Response
application/json
{ "favorite": { "favoriteId": "string", "type": "string", "params": {}, "displayName": "string", "createdAt": "2019-08-24T14:15:22Z" } }

List favorites

Request

List favorite items for a user, optionally filtered by type and search query.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
typesArray of strings

Filter by favorite types. If empty, returns all types.

querystring

Search query to filter favorites by display name.

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/favorites?types=string&query=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
favoritesArray of objects(ResolvedFavorite)
Response
application/json
{ "favorites": [ {} ] }