Skip to content
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

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

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

Responses

OK

Bodyapplication/json
travelArrangersArray of objects(TravelArrangerBasicInfo)required
travelArrangers[].​nameobject(Name)
travelArrangers[].​emailstring(email)
Example: "example@email.com"
travelArrangers[].​phoneNumbersArray of objects(PhoneNumber)
travelArrangers[].​userIdobject(UserId)required
travelArrangers[].​userId.​idstring(uuid)required
travelArrangers[].​statusstring(TravelerArrangerStatus)
Enum"PENDING""ACCEPTED""DENIED"
Response
application/json
{ "travelArrangers": [ {} ] }

Request

This endpoint gets user's external ID by user ID.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
includeInactiveboolean

Include inactive users.

Default false
Example: includeInactive=true
curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/external-id?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
externalIdstringrequired

A partner-assigned user identifier. This value must be unique for all travelers within a PNR.

Example: "user-1"
Response
application/json
{ "externalId": "user-1" }

Request

This endpoint updates user's external ID by user ID.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
includeInactiveboolean

Include inactive users.

Default false
Example: includeInactive=true
Bodyapplication/jsonrequired
externalIdstringrequired

A partner-assigned user identifier. This value must be unique for all travelers within a PNR.

Example: "user-1"
curl -i -X PUT \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/external-id?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "user-1"
  }'

Responses

OK

Response
No content