Skip to main content
API docs by Redocly

FeelyFeely Endpoints (1.0.0)

Download OpenAPI specification:Download

Auth [Don't Use]

Realm bearer token

Authorizations:
bearerAuth
header Parameters
Content-Type
string
Example: application/x-www-form-urlencoded
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: application/x-www-form-urlencoded
username
string
password
string
client_id
string
client_secret
string
grant_type
string

Responses

Realm users count

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce

Responses

Realm wellknown config

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce

Responses

User access token via user/pass

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
username
string
password
string

Responses

User info via access token with user/pass

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
username
string
password
string

Responses

User login

Authorizations:
bearerAuth
header Parameters
authid
string
Example: keycloak

From encrypted app identifier

Request Body schema: multipart/form-data
username
string

Username or email or password

password
string

Responses

User logout

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
refresh_token
string

Responses

User refresh token

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
refresh_token
number

Responses

User impersonate

Authorizations:
bearerAuth
header Parameters
authid
string
Example: 19825d43-61e8-4d60-a92d-8bf0b1bcbcc6
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
refresh_token
string

Responses

User access token info (introspection)

Authorizations:
bearerAuth
query Parameters
access_token
string
Example: access_token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjMzOTQ0NzUsImlhdCI6MTcyMzM5NDE3NSwianRpIjoiMzE2M2UxNWUtYjY3My00YmM4LWFmYjItZGQ2ZjFiY2ZlODY5IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6ImI1MDNjZGRhLTEwZGEtNDQwNi05NzJmLTg1OWI0MzJiNTNhNyIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.WeS07w03OL0YWe3EkXNzI1vbg8m0FeZT3aKBSO5rpjkwkR7xNZpArPZzYLjfKWlCr1eEbajKbEQagPEbMgS9H9Qj7n4AKv2A5qFbASHwpopnE0oXdHqW_fF6C17-Nux3EkR-cq7qlm_ZdeWrWEazJMptprTJCNJTtVqS6j0R6lcUA6503GuMY-nklqoY5xH9so9gRs1nWR4RNWYO-rdagbopXoRsQZnykhdJy7L703uUCu501WsQF8ne5tIPJO8HeSqnXJ8Xxuvwx8FvktdUXy7Gi9g7Ti15AOhHtkedNLKvp-mLyU0-eA5VEsw-wtv4--nWWYyFN2Ki1KhF07lGfw
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce

Responses

User access credentials

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce

Responses

User add

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
username
string
email
string
password
string
first_name
string
last_name
string

Responses

User update name

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
sub
string
first_name
string
last_name
string

Responses

User update password

Authorizations:
bearerAuth
header Parameters
authid
string
Example: authid
sid
string
Example: sid
authep
string
Example: authep
nonce
string
Example: nonce
Request Body schema: multipart/form-data
sub
string
password
string
otp
integer

Responses

Asset

Upload Asset

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: e9736fd7-2d4c-45f5-b946-61eabe29385e
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
files[]
string <binary>
eid
integer
oid
integer

Optional

toid
integer
claimid
integer
asid
string

One for each file, pass 0 for new files

description
string

One for each file

default
string

One for each file

logo
string

One for each file

cover
string

One for each file

deleted
string

One for each file

active
string
slider
string
advert
string
order_by
string

One for each file

Responses

Get asset by asid or uuid

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36

Responses

Get assets by attribute(s)

Authorizations:
bearerAuth
query Parameters
uid
integer
Example: uid=11
page
integer
Example: page=1
page_size
integer
Example: page_size=5
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36

Responses

Update Asset

Authorizations:
bearerAuth
path Parameters
asset_id
required
string
Example: 1ae4780e-5ce5-11ef-bd66-1efee427addd
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
active
integer
default
integer
deleted
integer

Responses

Cart

Create cart

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
uid
integer

Required

oid
string

Optional

eid_array
string
toid_array
string

Responses

Add to cart

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
uid
integer

Required

oid
string

Optional

field
string

eid_array, toid_array

items
string

Responses

Remove from cart

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
uid
integer

Required

oid
string

Optional

field
string

eid_array, toid_array

items
string

{5:1,6: 1, 7: 1}

Responses

Update cart

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
eid_array
string

Required

toid_array
string

Optional

Responses

Get cart basic

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

Config

Get sys config

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

CDN

Get file (image)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
X-Skip-Cache
string
Example: False

Responses

[CDN] Get file (image)

Authorizations:
bearerAuth

Responses

Collateral

Get AES Keys

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{cauthid}}

Responses

Get AES Keys History

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{cauthid}}

Responses

Rotate AES Keys

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{cauthid}}

Responses

Currency

Get currencies

Authorizations:
bearerAuth

Responses

Get countries

Authorizations:
bearerAuth

Responses

Get iso2 countries

Authorizations:
bearerAuth

Responses

Get currency codes

Authorizations:
bearerAuth

Responses

Get currency by country name

Authorizations:
bearerAuth

Responses

Get currency by country iso2

Authorizations:
bearerAuth

Responses

Get currency by currency code

Authorizations:
bearerAuth

Responses

Events

Add FF Google Event

Authorizations:
bearerAuth
header Parameters
authid
string
Example: afnadnfa-dakfjbkadjfb-dkjfbadkjbnfvgvgv

{{authid}}

nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
Request Body schema: multipart/form-data
etid
integer

33 - event

etid_model
integer
oid
integer
ecolid
integer
eintid
integer
name
string
country
string
locale
string
attr_2
string

generic web url

attr_15
string

generic description

attr_11
string

generic image

attr_33
integer

event date start

attr_34
integer

event date end

attr_42
string

event address

attr_43
string

event gmap url

Responses

Engagement

Add engagement

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Request Body schema: multipart/form-data
engtid
integer
uid
string

User ID

eid
integer

Entity ID

asid
string

Asset ID

oid
string

Organization ID

fbid
string

Feedback ID

toid
string

Tradeable Object ID

title
string

Engagement title

content
string

Engagement content

metadata_
string

Engagement metadata

Responses

Add engagement bulk

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Delete engagement

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Undelete engagement

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Get engagement history (of user)

Authorizations:
bearerAuth
query Parameters
page
integer
Example: page=1
page_size
integer
Example: page_size=50
header Parameters
authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.98888,
  • "status": 200,
  • "trace_id": "1741697521-I14fkmU5i5"
}

Get engagement history

Authorizations:
bearerAuth
query Parameters
page
integer
Example: page=1
page_size
integer
Example: page_size=10
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get engagement count

Authorizations:
bearerAuth
query Parameters
eid
integer
Example: eid=337
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get engagement count all

Authorizations:
bearerAuth
query Parameters
engtid
integer
Example: engtid=4
eid
integer
Example: eid=154
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get engagement summary

Authorizations:
bearerAuth
query Parameters
eid
integer
Example: eid=337
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Engagement > Engagement type

Get engagement types

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 2.839606,
  • "status": 200,
  • "trace_id": "1739730463-At4X4LKoqH"
}

Entity

Add entity

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
etid
integer
name
string

At least 10 characters required

country_iso2
string

Optional: Defaults to country of user if not provided

locale
string

Optional: Defaults to locale of user if not provided

eintid
integer
lid
integer
xxx
string

Responses

Update entity

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
etid
integer
name
string
country_iso2
string
locale
string
eintid
integer
lid
integer
xxx
string

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 6.479522,
  • "status": 201,
  • "trace_id": "1737243427-Nwc4mQlXF5"
}

Get entity by eid

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 609
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Get entity full by eid

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 575
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Get entity by uuid

Authorizations:
bearerAuth
path Parameters
uuid
required
string
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Get entity by name (match)

Authorizations:
bearerAuth
query Parameters
name
string
Example: name=iphone
limit
integer
Example: limit=5
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Get entity by eid (for edit)

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 608
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 7.295144,
  • "status": 200,
  • "trace_id": "1739460352-AnM5OAbVfA"
}

Get all entities (paginated)

Authorizations:
bearerAuth
path Parameters
page
required
integer
Example: 1
limit
required
integer
Example: 50
header Parameters
authid
string
Example: e9736fd7-2d4c-45f5-b946-61eabe29385e
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 3.491534,
  • "status": 200,
  • "trace_id": "1739628300-3us4rPOj9O"
}

Set entity flag

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 609
header Parameters
Authm
string
Example: local
Authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
field
string

'deleted', 'active', 'published', 'archive', 'age_restricted'

value
integer

0,1

Responses

Delete entity (pseudo)

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 238
header Parameters
Authm
string
Example: local
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json

Responses

Undelete entity (pseudo)

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 575
header Parameters
Authm
string
Example: local
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
eid
integer

Responses

Entity location hierarchy

Authorizations:
bearerAuth
query Parameters
country
string
Example: country=ghana
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity > Entity Attribute

Add entity attribute(s)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Update entity attribute(s)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Set entity flag attribute

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
flag_field
string

autogen, default, active, deleted

flag_value
integer

Responses

Entity > Entity Attribute Type

Entity attribute type

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity > Entity Collection

Add entity collection

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
oid
integer
name
string
description
string
private
integer

Responses

Get entity collection(s)

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: 3b35508d-28f3-4f09-b50e-75279dd06b40
authm
string
Example: local
sid
string
Example: sid

Responses

Add entity to collection

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
ecolid
integer
eid
string

Responses

Update entity collection

Authorizations:
bearerAuth
path Parameters
ecolid
required
integer
Example: 5
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
name
string
description
string

Responses

Delete entity collection

Authorizations:
bearerAuth
path Parameters
ecolid
required
integer
Example: 1
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json

Responses

Remove from entity collection

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json

Responses

Move entity from/to collection

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: {{authid}}
Accept
string
Example: application/json
Request Body schema: multipart/form-data
eid
integer
from_ecolid
string
to_ecolid
string

Responses

Get all entity in collections [eid array]

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: 3b35508d-28f3-4f09-b50e-75279dd06b40
authm
string
Example: local
sid
string
Example: sid

Responses

Get entities in entity collection

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Entity > Entity Feedback Type

Get entity feedback type

Authorizations:
bearerAuth
path Parameters
fbtid
required
integer
Example: 1
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Get all entity feedback type

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Add entity feedback type

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid
Request Body schema: multipart/form-data
name_system
string
name
string
description
string
etid
string
active
integer

Responses

Update entity feedback type

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid
Request Body schema: multipart/form-data
name_system
string
name
string
description
string
etid
string
active
integer

Responses

Entity > Entity Spec

Entity spec dynamic

Authorizations:
bearerAuth
query Parameters
etid
integer
Example: etid=2

32 - item 406 - mobile_device 21 - place 191 - business 8 - car 10 - suv 7 - vehicle 12 - motorcycle 2 - property

header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
Example
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 18.065301,
  • "status": 201,
  • "trace_id": "1736961833-eDV92BA1GJ"
}

Entity > Entity Type

Entity types

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.42399,
  • "status": 201,
  • "trace_id": "1737159543-clWkQq91I4"
}

Entity types basic

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type id by name

Authorizations:
bearerAuth
path Parameters
name
required
string
Example: place
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type name match

Authorizations:
bearerAuth
path Parameters
name
required
string
Example: home
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity types basic (etid)

Authorizations:
bearerAuth
path Parameters
etid
required
integer
Example: 21
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 39.523067,
  • "status": 201,
  • "trace_id": "1737162720-4Mqh2B0R9K"
}

Entity types hierarchy basic (etid)

Authorizations:
bearerAuth
path Parameters
etid
required
integer
Example: 2
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 7.185916,
  • "status": 201,
  • "trace_id": "1740104944-qmZuCAjHW1"
}

Entity types name (etid)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 37.14857,
  • "status": 201,
  • "trace_id": "1737208359-ZQXsYU4Ezr"
}

Entity type hierarchy

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
Example
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 3.197619,
  • "status": 201,
  • "trace_id": "1737149237-zM1hhK1qgC"
}

Entity type hierarchy with counts

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type hierarchy by name

Authorizations:
bearerAuth
query Parameters
name
string
Example: name=electronics
include_inactive
boolean
Example: include_inactive=true
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type lineage

Authorizations:
bearerAuth
path Parameters
etid
required
integer
Example: 228
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity > Entity Mobile Device

Match device models from key

Authorizations:
bearerAuth
query Parameters
key
string
Example: key=nokia_235_4g_(2024)-12967
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 14.408841,
  • "status": 201,
  • "trace_id": "1737444216-w0peN59Snf"
}

Match device models from Imei

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get mobile device (image) public

Authorizations:
bearerAuth
header Parameters
Accept
string
Example: application/json
X-Skip-Cache
string
Example: False

Responses

Match device models from 2020 to Date

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 481.981478,
  • "status": 201,
  • "trace_id": "1741144535-lAVT2Tr1ie"
}

Entity > Entity Vehicle

Get vehicle basic info by VIN

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
Example

Get vehicle years

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 2.247636,
  • "status": 201,
  • "trace_id": "1736470750-S5bqlSJ7J6"
}

Get vehicle makes by year

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2021
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.161362,
  • "status": 201,
  • "trace_id": "1736470861-hJLgzJxASE"
}

Get vehicle models by year, make

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2023
make
required
string
Example: Hyundai
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
Example
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 1.831859,
  • "status": 201,
  • "trace_id": "1737836295-P29SQlITlu"
}

Get vehicle trims by year, make, model

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2023
make
required
string
Example: Honda
model
required
string
Example: CR-V
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.487907,
  • "status": 201,
  • "trace_id": "1737836585-Ki1wPZX8x7"
}

Get vehicle basic info by Year, Make, Model

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2025
make
required
string
Example: Chevrolet
model
required
string
Example: Equinox
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: e9736fd7-2d4c-45f5-b946-61eabe29385e
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
Example

Get vehicle basic info by Year, Make, Model, Trim

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2020
make
required
string
Example: BMW
model
required
string
Example: X5
trim
required
string
Example: sDrive40i
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
Example

Get HD vehicle years

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 2.247636,
  • "status": 201,
  • "trace_id": "1736470750-S5bqlSJ7J6"
}

Get HD vehicle makes by Year

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2014
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get HD vehicle models by Year, Make

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2014
make
required
string
Example: Volvo Truck
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get motor years

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.901562,
  • "status": 201,
  • "trace_id": "1736475324-i7HZsuCNyO"
}

Get motor makes by year

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 2.038851,
  • "status": 201,
  • "trace_id": "1737037531-MtAGMpZrFk"
}

Get motor models by year, make

Authorizations:
bearerAuth
path Parameters
year
required
integer
Example: 2020
make
required
string
Example: Volvo
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.641278,
  • "status": 201,
  • "trace_id": "1737849165-FTJpgCRnU7"
}

Get motor trims by year, make, model

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 2.768184,
  • "status": 201,
  • "trace_id": "1737908750-ZMFOuTUDpM"
}

Get motor basic info by Year, Make, Model

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity > Entity Engagement

Entity > Entity Event

Entity > Entity Location

Get entities with null location

Authorizations:
bearerAuth
query Parameters
limit
integer
Example: limit=2
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Sync entities with null location

Authorizations:
bearerAuth
query Parameters
limit
integer
Example: limit=2
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Decode gpgps code

Authorizations:
bearerAuth
path Parameters
code
required
string
Example: GU-564-5765

examples GU-564-9730, GU-564-5765

header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.923734,
  • "status": 200,
  • "trace_id": "1740347049-l2qAs1jbmO"
}

Encode coord to gpgps code

Authorizations:
bearerAuth
path Parameters
lat
required
number
Example: 5.55409938451693
lon
required
number
Example: -0.269606768709007
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.88512,
  • "status": 200,
  • "trace_id": "1740347784-TF1A92hICP"
}

Get popular entity locations [public]

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity > Entity Intent

Get entity intents

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Get entity intents by etid

Authorizations:
bearerAuth
path Parameters
etid
required
integer
Example: 18
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Entity > Entity Promotion

Get entity toid promotions

Authorizations:
bearerAuth
query Parameters
eid
integer
Example: eid=225
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Response samples

Content type
application/json
Example
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 43.633877,
  • "status": 200,
  • "trace_id": "1737123190-sq9PRLulpI"
}

Entity > Entity Item

Get entity product match

Authorizations:
bearerAuth
path Parameters
prompt
required
string
Example: samsung s25 edge
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Response samples

Content type
application/json
Example
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 43.633877,
  • "status": 200,
  • "trace_id": "1737123190-sq9PRLulpI"
}

Get entity product spec

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 11.584234,
  • "status": 200,
  • "trace_id": "1737256091-PLY3WpRsnq"
}

Get entity product spec v2

Authorizations:
bearerAuth
path Parameters
prompt
required
string
Example: macbook pro m4
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
Example
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 11.584234,
  • "status": 200,
  • "trace_id": "1737256091-PLY3WpRsnq"
}

Add entity with attribute(s)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: ac28b364-cf16-414d-a4fc-b4d6243f7f54
Sid
string
Example: {{sid}}
Authep
string
Example: authep
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
"{\n \"entity\": {\n \"name\": \"Oppo A3\",\n \"description\": \"Introducing the Oppo A3, a powerful and sleek mobile device perfect for your on-the-go needs. Featuring a 256GB storage capacity and 8GB of RAM, this brand-new device offers ample space and lightning-fast performance. Housed in a sleek black design, the Oppo A3 is the perfect companion for your daily digital adventures.\",\n \"private\": 0,\n \"social\": 0,\n \"country_iso2\": \"GH\",\n \"locale\": \"en-US\",\n \"dup_override\": 1,\n \"etid\": 406,\n \"eintid\": 1,\n \"lid\": 128,\n //\"oid\": 10,\n //\"eid\": 242,\n \"published\": 0,\n \"model_json\": {\n \"etid\": 10,\n \"make\": \"BMW\",\n \"model\": \"X5\",\n \"model_id\": \"2020~BMW~X5\",\n \"photos\": [\n \"https://di-uploads-pod24.dealerinspire.com/motorwerksbmw1/uploads/2019/10/2020-BMW-X5-MLP-Hero.png\",\n \"https://vehicle-images.dealerinspire.com/de32-18003855/5UX23EU07S9Y89187/c9868ddd731f0230914b312ded1e3448.jpg\",\n \"https://vehicle-images.dealerinspire.com/212e-110008857/5UXCR4C04L9C05425/e737cd2190c59e28a2232a6b6378895e.jpg\",\n \"https://vehicle-images.dealerinspire.com/d6fc-18003855/5UX13EU06S9Y95560/5cae902ede4953f65eff85f98737d926.jpg\",\n \"https://65e81151f52e248c552b-fe74cd567ea2f1228f846834bd67571e.ssl.cf1.rackcdn.com/ldm-images/2020-BMW-X5-Artic-Grey-Metallic-Color.png\"\n ],\n \"year\": \"2020\"\n }\n },\n \"entity_attribute\": [\n {\n \"eatid\": 47,\n \"content\": \"apple_iphone_15_pro_max-12548\"\n },\n {\n \"eatid\": 14,\n \"content\": \"New\"\n },\n {\n \"eatid\": 13,\n \"content\": \"Black\"\n },\n {\n \"eatid\": 115,\n \"content\": \"256GB 8GB RAM\"\n },\n /*{\n \"eatid\": 15,\n \"content\": \"Introducing the Oppo A3, a powerful and sleek mobile device perfect for your on-the-go needs. Featuring a 256GB storage capacity and 8GB of RAM, this brand-new device offers ample space and lightning-fast performance. Housed in a sleek black design, the Oppo A3 is the perfect companion for your daily digital adventures.\"\n },*/\n {\n \"eatid\": 131,\n \"content\": \"pickup\"\n },\n {\n \"eatid\": 82,\n \"content\": \"1\"\n },\n {\n \"eatid\": 111,\n \"content\": [\n \"1\"\n ]\n },\n {\n \"eatid\": 167,\n \"content\": \"1\"\n }\n ]\n }"

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 7.126382,
  • "status": 201,
  • "trace_id": "1737238644-qtqqScpxIb"
}

Add entity with attribute(s) silent check

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
Sid
string
Example: {{sid}}
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Authorization
string
Example: Fxn_post_ex xxx
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "entity": {
    },
  • "entity_attribute": [ ]
}

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 7.126382,
  • "status": 201,
  • "trace_id": "1737238644-qtqqScpxIb"
}

Entity > Entity Place

Get entity place name match

Authorizations:
bearerAuth
query Parameters
name
string
Example: name=ZTE
limit
integer
Example: limit=5
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Get entity place type by name

Authorizations:
bearerAuth
path Parameters
name
required
string
Example: restaurant
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 2.2583,
  • "status": 201,
  • "trace_id": "1740239426-knM2PZ4S1d"
}

Get entity place name disambiguate

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: {{sid}}
Request Body schema: multipart/form-data
name
string
lid
integer
etid
integer

Responses

Entity > Entity Property

Get entities pending matterport

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid
Request Body schema: multipart/form-data
toid
string

Responses

Sync entities pending matterport by eid

Authorizations:
bearerAuth
query Parameters
eid
string
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid
Request Body schema: multipart/form-data
toid
string

Responses

Feedback

Post Feedback

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "eid": 110,
  • "title": "feedback 4",
  • "content": "testing feedback comment type 4",
  • "fbtid": 1,
  • "social": 1
}

Get Feedback

Authorizations:
bearerAuth

Responses

Put Feedback

Authorizations:
bearerAuth

Responses

DEL Hard Feedback

Authorizations:
bearerAuth
query Parameters
erase
string
Example: erase=True

Responses

Feedback > FeedbackType

GET ALL FeedbackType

Authorizations:
bearerAuth

Responses

GET Feedback Type

Authorizations:
bearerAuth

Responses

Location

Get location by ID

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get location hierarchy by ID

Authorizations:
bearerAuth
path Parameters
lid
required
integer
Example: 14

Ghana = 14

query Parameters
include_inactive
boolean
Example: include_inactive=false
exclude_fields
string
Example: exclude_fields=polygon,nearby
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get location hierarchy basic by ID

Authorizations:
bearerAuth
query Parameters
lid
integer
Example: lid=206
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get location by name

Authorizations:
bearerAuth
query Parameters
name
string
Example: name=Tema
partial_match
string
Example: partial_match=False
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Messaging

Send offline message

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
sid
string
Example: sid
authm
string
Example: local
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
"{\n \"recipient_id\": 32,\n \"sender_oid\": null, // Optional\n \"recipient_oid\": null, // Optional\n \"message\": \"Hello, how are you?\",\n \"entity_id\": null, //Optional\n \"attachment\": null,\n \"priority\": \"normal\" // Required: normal or high\n}"

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": 200
}

Get historical messages

Authorizations:
bearerAuth
query Parameters
recipient_id
integer
Example: recipient_id=32
sender_id
integer
Example: sender_id=32
page
integer
Example: page=1
page_size
integer
Example: page_size=10
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
sid
string
Example: sid
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": 200
}

Get message summary

Authorizations:
bearerAuth
query Parameters
recipient_id
integer
Example: recipient_id=32
sender_id
integer
Example: sender_id=32
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
sid
string
Example: sid
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": 200
}

Get unique conversations

Authorizations:
bearerAuth
query Parameters
id
integer
Example: id=32
header Parameters
authid
string
Example: {{authid}}
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": 200
}

Get unique conversations (with perspective)

Authorizations:
bearerAuth
query Parameters
id
integer
Example: id=32
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
sid
string
Example: 081efee4-50f9-45db-9f30-70b9b5f7ec38
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": 200
}

Organization

Get organization categories

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
sid
string
Example: {{sid}}
authep
string
Example: authep
authm
string
Example: local

Responses

Get organization by oid

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 5
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get organization by uuid

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get organization invite link

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Create organization

Authorizations:
noauthAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Authorization
string
Example: Fxn_Post_Execute {{AuthToken}}
Request Body schema: multipart/form-data
name
string
ocid
integer
country
string
locale
string

Responses

Update organization

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
name
string

Can't be changed, requires account review

ocid
integer

Can't be changed, requires account review

country
string

Can't be changed, requires account review

locale
string

Responses

Delete organization (pseudo)

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 7
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Undelete organization (pseudo)

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Activate organization

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Deactivate organization

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Set organization profile photo

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
files[]
string <binary>
oid
integer

Responses

Organization > Organization user

Get organization users by oid

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 7
header Parameters
authid
string
Example: ac28b364-cf16-414d-a4fc-b4d6243f7f54
authep
string
Example: f6bXeg1BK8OwqIfQL0zJl7QvrU6ZqJYvSf/XEMcBNnlWPGL7AD82Zwq9Ee3fFI2G
sid
string
Example: d82fccd9-d014-44f1-b218-90342e3d6af3
authm
string
Example: local

Responses

Search for a user (rate-limited)

Authorizations:
bearerAuth
query Parameters
phone
string
Example: phone= 19177890521

Optional

email
string

Optional

username
string
Example: username=ekowtaylor342
header Parameters
authid
string
Example: {{authid}}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Add organization user (FF)

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
uid
string

or csv string or UID, for example Single user 14 Multiple users 14,15,16

active
boolean

or CSV string

role
string

or CSV string of roles

  • administrator – manager
  • viewer

Responses

Invite organization user (non-FF) via email or phone

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
email
string

CSV string of emails

phone
integer

CSV string of phone (optional)

role
string

CSV string of roles

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 4.284604,
  • "status": 201,
  • "trace_id": "1739483134-X8UL8R5bY6"
}

Invite organization user (combined) via email or phone

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 7
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
email
string

CSV string of emails

phone
integer

CSV string of phone (optional)

role
string

CSV string of roles (names or ids)

Responses

Add organization user via invite string (Non-FF)

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Delete (pseudo) organization user

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Undelete (pseudo) organization user

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Request Body schema: multipart/form-data
uid
integer
active
boolean
role
string

Responses

Activate organization user

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Request Body schema: multipart/form-data
uid
integer
active
boolean
role
string

Responses

Deactivate organization user

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Request Body schema: multipart/form-data
uid
integer
active
boolean
role
string

Responses

Assign role to organization user

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 7
uid
required
integer
Example: 14
rid
required
integer
Example: 2
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Complete organization user onboarding

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
object

Responses

Get all pending org membership requests (FF)

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 2.737754,
  • "status": 200,
  • "trace_id": "1736614464-Tc2ANl2ynF"
}

Get all pending org membership requests (non-FF)

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 10
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 2.279635,
  • "status": 200,
  • "trace_id": "1739531067-0mOmVM9RLe"
}

Get all pending org membership requests (combined)

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 12
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 4.914446,
  • "status": 200,
  • "trace_id": "1739830645-NCXY2dRku4"
}

Delete pending organization user request (non-FF)

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 9

Organization ID

id
required
string

User identifier (phone, email, or hash)

header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 2.058091,
  • "status": 200,
  • "trace_id": "1739807173-0jGFC3uglW"
}

Update pending organization user request role (non-FF)

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 10

Organization ID

id
required
string

User identifier (phone, email, or hash)

role
required
string
Example: administrator

New role to assign

header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local
Request Body schema: multipart/form-data
uid
integer
active
boolean
role
string

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 2.107578,
  • "status": 200,
  • "trace_id": "1739806602-xGe8zVQjK7"
}

Get my pending org membership requests

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 4.847937,
  • "status": 404,
  • "trace_id": "1736613649-59UOt6u1EF"
}

Organization > Organization user > Organization User Preference

Get organization user preferences

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 5
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get organization user preference details

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 5
opid
required
integer
Example: 6
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Set organization user preference

Authorizations:
noauthAuth
path Parameters
oid
required
integer
Example: 5
opid
required
integer
Example: 7
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Authorization
string
Example: Fxn_Post_Execute {{AuthToken}}
Request Body schema: multipart/form-data
preference
integer

Responses

Organization > Organization user role

Get organization user roles

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Organization > Organization entity

Get organization entities

Authorizations:
bearerAuth
query Parameters
oid
integer
Example: oid=7
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.64826,
  • "status": 200,
  • "trace_id": "1736358038-EsHXZ3B2cP"
}

Organization > Organization preference

Get organization preferences

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 5
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get organization preference details

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 5
opid
required
integer
Example: 6
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Set organization preference

Authorizations:
noauthAuth
path Parameters
oid
required
integer
Example: 5
opid
required
integer
Example: 7
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Authorization
string
Example: Fxn_Post_Execute {{AuthToken}}
Request Body schema: multipart/form-data
preference
integer

Responses

Price

Add price

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
prictid
integer

Required, 1-selling, 2-cost

ccode
string

Optional

country_iso2
string

Required

uid_actor
string

DON'T USE

oid_actor
string

Optional

price
integer

Required

price_per
integer

Lookup Price Per

oid
string

Optional

eid
integer

Entity ID

toid
string
eaid
string
description
string
tradeable
integer

Responses

Get price

Authorizations:
bearerAuth
query Parameters
eid
integer
Example: eid=198
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Update price

Authorizations:
bearerAuth
path Parameters
pricid
required
integer
Example: 349
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
price
integer

Required, decimal or integer

oid
integer
eid
integer
toid
string
eaid
string
active
integer
description
string
ccode
string
country_iso2
string
price_per
integer
prictid
integer

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 5.163295,
  • "status": 200,
  • "trace_id": "1744450193-Bp6yfmBlTO"
}

Get price with details

Authorizations:
bearerAuth
query Parameters
eid
integer
Example: eid=198
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Price > Price Per

Get price per types

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Payment

Make payment

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: ac28b364-cf16-414d-a4fc-b4d6243f7f54
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
oid
string

Optional

wid
string

Optional: Wallet ID

invid
integer
ccode
string
amount
number
ref_id
string

Optional

ref_notes
integer

Optional

psid
integer

Required: 2 = paystack

Responses

Update payment

Authorizations:
bearerAuth
path Parameters
pid
required
integer
Example: 17
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
oid
string

Optional

wid
string

Optional: Wallet ID

invid
integer
ccode
string
amount
number
ref_id
string

Optional

ref_notes
string

Optional

psid
integer

{ "name": "feelyfeely", "psid": 3 }, { "name": "gift card", "psid": 6 }, { "name": "mtn mobile money", "psid": 4 }, { "name": "paystack", "psid": 2 }, { "name": "user wallet", "psid": 1 }, { "name": "vdf cash", "psid": 5 }

Responses

Get payment by pid

Authorizations:
bearerAuth
path Parameters
pid
required
integer
Example: 45
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Get payment by eid

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 619
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Get payment details

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get all payments

Authorizations:
bearerAuth
header Parameters
authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Payment > Payment Sources

Get payment sources

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Promotion

Get promotions (ads+sliders)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: {{authid}}
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Add promotion basic

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: ac28b364-cf16-414d-a4fc-b4d6243f7f54
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
oid
string

Optional

wid
string

Optional: Wallet ID

invid
integer
ccode
string
amount
number
ref_id
string

Optional

ref_notes
integer

Optional

psid
integer

Required: 2 = paystack

date_start
string

Responses

Get promotions (ads)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: {{authid}}
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get promotions (sliders)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: {{authid}}
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get promotions specs

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Search promotions target user, org or entity

Authorizations:
bearerAuth
query Parameters
target
string
Example: target=iphone

eid, oid, uuid, or name

header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: {{authid}}
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Add promotion complete

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: ac28b364-cf16-414d-a4fc-b4d6243f7f54
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
"{\n \"payment\": {\n \"invid\": 196,\n \"ccode\": \"GHS\",\n \"amount\": 1.7250,\n \"ref_id\": \"T606566330188650\",\n \"ref_notes\": \"10101\",\n \"psid\": 2 // paystack\n },\n \"promotion\": {\n \"oid_actor\": null,\n \"toid\": 47,\n \"asid\": 102, // or uuid\n \"eid\": 609,\n \"uid\": null,\n \"oid\": null,\n \"name\": \"My promotion\",\n \"description\": \"description\",\n \"description_summmary\": \"description_summmary\",\n \"tagline\": \"some tagline\"\n },\n \"target\": {\n \"demographic\": [],\n \"age_groups\": [],\n \"primary_categories\": [],\n \"locations\": [],\n \"personas\": [],\n \"device_types\": []\n }\n \n}"

Public

Public > CDN

Get file (image) by bucket and path [public]

Authorizations:
bearerAuth
path Parameters
bucket
required
string
Example: ff.organization.assets
path
required
number
Example: bc78ed63-24e7-4f5b-a1fb-ee1d10da90ee/medium/2018-mercedes-amg-s63-zc_1739378955.7660081.jpg
header Parameters
Accept
string
Example: application/json
X-Skip-Cache
string
Example: False

Responses

Public > Entity

Get entity by eid [public]

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 298
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.515195,
  • "status": 200,
  • "trace_id": "1741180851-6NQwDXvafR"
}

Get entity by slug [public]

Authorizations:
bearerAuth
query Parameters
slug
string
Example: slug=market/feature_phone/new-vivo-v40-lite-4g-(idn)-red-512gb-8gb-ram-for-sale-chomina-pq82xj
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.515195,
  • "status": 200,
  • "trace_id": "1741180851-6NQwDXvafR"
}

Get entity full by eid [public]

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 669
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.515195,
  • "status": 200,
  • "trace_id": "1741180851-6NQwDXvafR"
}

Get entity full by slug [public]

Authorizations:
bearerAuth
query Parameters
slug
string
Example: slug=market/feature_phone/new-vivo-v40-lite-4g-(idn)-red-512gb-8gb-ram-for-sale-chomina-pq82xj
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.515195,
  • "status": 200,
  • "trace_id": "1741180851-6NQwDXvafR"
}

Get entities [public]

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.355675,
  • "status": 200,
  • "trace_id": "1741180793-kmpcixwuUs"
}

Get entities by category [public]

Authorizations:
bearerAuth
path Parameters
cat
required
string
Example: places

etid or name

header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": [
    ],
  • "exec_time": 5.203237,
  • "status": 200,
  • "trace_id": "1741180881-MQqYQFwuQp"
}

Get entities by category with pagination [public]

Authorizations:
bearerAuth
path Parameters
cat
required
string
Example: homes
page
required
integer
Example: 1
per_page
required
integer
Example: 50
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Get organization entities [public]

Authorizations:
bearerAuth
query Parameters
oid
integer
Example: oid=7
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.64826,
  • "status": 200,
  • "trace_id": "1736358038-EsHXZ3B2cP"
}

Get user account entities [public]

Authorizations:
bearerAuth
path Parameters
page
required
integer
Example: 1
limit
required
integer
Example: 10
query Parameters
uid
integer
Example: uid=32
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": [
    ],
  • "exec_time": 0.64826,
  • "status": 200,
  • "trace_id": "1736358038-EsHXZ3B2cP"
}

Search entity by eid [public]

Authorizations:
bearerAuth
path Parameters
eid
required
integer
Example: 562
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Search entity by doc_id [public]

Authorizations:
bearerAuth
path Parameters
doc_id
required
string
Example: 3dc6b007-03f8-11f0-8b74-beef817a577c
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Search results by prompt [public]

Authorizations:
bearerAuth
query Parameters
name
string
Example: name=iphone
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Category search results by params [public]

Authorizations:
bearerAuth
query Parameters
page
integer
Example: page=1
page_size
integer
Example: page_size=25
country
string
Example: country=GH

GH

price_country
string
Example: price_country=GH

GH

sort_field
string
Example: sort_field=date_added

"date_added", "price", or "discount"

sort_order
string
Example: sort_order=desc

"asc" or "desc"

header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Category search filters by params [public]

Authorizations:
bearerAuth
query Parameters
country
string
Example: country=GH

GH

price_country
string
Example: price_country=GH

GH

header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Public > Entity > Similar

Get similar entities [public]

Authorizations:
bearerAuth
query Parameters
eid
integer
Example: eid=374
page
integer
Example: page=1
page_size
integer
Example: page_size=1
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.195781,
  • "status": 200,
  • "trace_id": "1743578060-Ldi7iA2wac"
}

Public > Entity Type (Categories and Menus)

Entity type hierarchy by id [public]

Authorizations:
bearerAuth
query Parameters
etid
integer
Example: etid=32

"market": 32, "homes": 2, "places": 21, "events": 33

include_inactive
boolean
Example: include_inactive=false

true, false

header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type mid section menu [public]

Authorizations:
bearerAuth
path Parameters
menu
required
string
Example: main

main, market, home, place, event

header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type lineage [public]

Authorizations:
bearerAuth
path Parameters
etid
required
integer
Example: 225
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type hierarchy [public]

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Entity type hierarchy with counts [public]

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Public > Landing Pages

Get slideshow entities [public]

Authorizations:
bearerAuth
query Parameters
slider_main
integer
Example: slider_main=1
slider_market
integer
Example: slider_market=0
slider_home
integer
Example: slider_home=0
slider_place
integer
Example: slider_place=0
slider_event
integer
Example: slider_event=0
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Public > User Account

Log non-auth user FP [public]

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "requestId": "1742767490793.ZYkwZa",
  • "browserName": "Chrome",
  • "browserVersion": "134.0.0",
  • "confidence": {
    },
  • "device": "Other",
  • "firstSeenAt": {
    },
  • "incognito": false,
  • "ip": "146.70.173.215",
  • "lastSeenAt": {
    },
  • "meta": {
    },
  • "os": "Mac OS X",
  • "osVersion": "10.15.7",
  • "visitorFound": true,
  • "visitorId": "v3TnLl2N78EzdPW1MOmX",
  • "cacheHit": false
}

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": {
    },
  • "exec_time": 0.173786,
  • "status": 200,
  • "trace_id": "1742772523-RM6BvrQ3NG"
}

Get user profile photo

Authorizations:
bearerAuth
path Parameters
uid
required
integer
Example: 32
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get user stats

Authorizations:
bearerAuth
path Parameters
uid
required
integer
Example: 32
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Public > Organization

Get organization stats

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 11
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Get organization profile photo

Authorizations:
bearerAuth
path Parameters
oid
required
integer
Example: 11
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Public > Slider

Get slider [public]

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 1.102261,
  • "status": 200,
  • "trace_id": "1746504497-XAqklvz9Ww"
}

Purchase

Make purchase (transactions and invoice)

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
"{\n \"transactions\": [\n {\n \"uid_to\": null, // Recipient User ID (Optional, null for business purchase)\n \"oid_from\": null, // Optional Owner ID (Can be omitted)\n \"oid_to\": null, // Optional Owner ID (null for business purchase)\n \"toid_old\": 17, // Old or current Tradeable Object ID (Optional, required for upgradet)\n \"toid\": 18, // Tradeable Object ID (Optional, required if 'eid' is not present)\n \"eid\": null, // Entity ID (Optional, required if 'toid' is not present)\n \"eid_p\": 425, // Entity ID (required if 'toid' is meant for an entity)\n \"ttid\": 6, // Transaction Type ID (Optional, see GET:/v2/transaction/type)\n \"quantity\": 1, // Number of items (Required)\n \"ccode\": \"GHS\", // Currency Code (Required)\n \"country_iso2\": \"GH\" // Country Code (Required)\n },\n {\n \"uid_to\": null, // Recipient User ID (Optional, null for business purchase)\n \"oid_from\": null, // Optional Owner ID (Can be omitted)\n \"oid_to\": null, // Optional Owner ID (null for business purchase)\n \"toid_old\": null, // Old or current Tradeable Object ID (Optional, required for upgradet)\n \"toid\": 19, // Tradeable Object ID (Optional, required if 'eid' is not present)\n \"eid\": null, // Entity ID (Optional, required if 'toid' is not present)\n \"eid_p\": 425, // Entity ID (required if 'toid' is meant for an entity)\n \"ttid\": 1, // Transaction Type ID (Optional, see GET:/v2/transaction/type)\n \"quantity\": 1, // Number of items (Required)\n \"ccode\": \"GHS\", // Currency Code (Required)\n \"country_iso2\": \"GH\" // Country Code (Required)\n },\n {\n \"uid_to\": null, // Recipient User ID (Optional, null for business purchase)\n \"oid_from\": null, // Optional Owner ID (Can be omitted)\n \"oid_to\": null, // Optional Owner ID (null for business purchase)\n \"toid_old\": null, // Old or current Tradeable Object ID (Optional, required for upgradet)\n \"toid\": 19, // Tradeable Object ID (Optional, required if 'eid' is not present)\n \"eid\": null, // Entity ID (Optional, required if 'toid' is not present)\n \"uid_p\": 32, // Entity ID (required if 'toid' is meant for an entity)\n \"ttid\": 1, // Transaction Type ID (Optional, see GET:/v2/transaction/type)\n \"quantity\": 1, // Number of items (Required)\n \"ccode\": \"GHS\", // Currency Code (Required)\n \"country_iso2\": \"GH\" // Country Code (Required)\n }\n ]\n}"

Search

Search API Documentation

Authorizations:
bearerAuth

Responses

Match to known product

Authorizations:
bearerAuth
query Parameters
prompt
string
Example: prompt=bmw x3
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Serp Sync

Get and Sync Event Place Copy

Authorizations:
bearerAuth
query Parameters
limit
integer
Example: limit=1

Optional

header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

Tag

Search tag by name

Authorizations:
bearerAuth
query Parameters
q
string
Example: q=toyota
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Get popular tags [public]

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Tradeable Object

Get tradeable objects

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get tradeable object by id

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Get tradeable object by etid

Authorizations:
bearerAuth
query Parameters
etid
integer
Example: etid=200
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local

Responses

Response samples

Content type
application/json
{
  • "cached": "True",
  • "data": {
    },
  • "exec_time": 0.64496,
  • "status": 200,
  • "trace_id": "1738700018-ySQ1nV1F5w"
}

Tradeable Object > Tradeable Object Types

Get tradeable objects types

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Transaction

Transaction > Transaction Type

Get all transaction types

Authorizations:
bearerAuth
header Parameters
authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
authep
string
Example: authep
sid
string
Example: sid
authm
string
Example: local

Responses

Timezone

Timezones

Authorizations:
bearerAuth
query Parameters
city_or_region
string
Example: city_or_region=accra
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

User Account

API Documentation

Authorizations:
bearerAuth

Responses

User account add

Authorizations:
bearerAuth
header Parameters
authid
string
Example: afnadnfa-dakfjbkadjfb-dkjfbadkjbnfvgvgv

{{authid}}

nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
Request Body schema: multipart/form-data
authid
string

REQUIRED: Provided behind the scenes by admin

first_name
string
last_name
string
other_names
string
preferred_name
string
address
string
dob
string

optional

phone1
string
phone2
string

optional

email1
string

REQUIRED: Provided behind the scenes by admin

email2
string
username
string

REQUIRED: Provided behind the scenes by admin

country_iso2
string
tz
integer

-14 to +12

Responses

User account update

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a
Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
first_name
string

Can't be changed, requires account review

last_name
string

Can't be changed, requires account review

other_names
string

Can't be changed, requires account review

preferred_name
string
address_res
string

Can't be changed, requires account review

address_post
string
dob
string

Can't be changed, requires account review

phone1
string

Can't be changed, requires account review

phone2
string
email1
string

Can't be changed, requires account review

email2
string

Timezone ID (tzid) or tz e.g. 1 or Africa/Accra

country_iso2
string

Requires account review

timezone
integer

Responses

Response samples

Content type
application/json
{
  • "cached": false,
  • "data": {
    },
  • "exec_time": 10.063692,
  • "status": 200,
  • "trace_id": "1736862825-0SZpcydKua"
}

User account signup

Authorizations:
noauthAuth
header Parameters
Authorization
string
Example: Bearer fsdfszdgfsathrwiuhbglurbagubawrultbglrw
authid
string
Example: afnadnfa-dakfjbkadjfb-dkjfbadkjbnfvgvgv

{{authid}}

authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local

local or sso

sid
string
Request Body schema: multipart/form-data
first_name
string

Required

last_name
string

Required

other_names
string

Optional

preferred_name
string

Optional

address_res
string

Optional

address_post
string

Optional

dob
string

YYYY-MM-DD

phone1
string
phone2
string

Optional

email1
string

Required

email2
string

Optional

username
string

Optional (generated from email)

password
string

Required

country_iso2
string

Required, Geocoded to default location

timezone
integer

Required, -14 to +12

Responses

User account login

Authorizations:
bearerAuth
header Parameters
authid
string
Example: afnadnfa-dakfjbkadjfb-dkjfbadkjbnfvgvgv

{{authid}}

nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
Request Body schema: multipart/form-data
phone
string

One of phone, email or username required

email
string

One of phone, email or username required

username
string

One of phone, email or username required

password
string

Starbright@12

Responses

User account logout

Authorizations:
bearerAuth
header Parameters
authid
string
Example: afnadnfa-dakfjbkadjfb-dkjfbadkjbnfvgvgv

{{authid}}

nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
Request Body schema: multipart/form-data
phone
string

One of phone, email or username required

email
string

One of phone, email or username required

username
string

One of phone, email or username required

password
string

Responses

User account change verification with pin via email

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g

{{authid}}

Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
email
string

One of phone, email or username required

change_type
string

"generic": "generic", "verify": "verify", "email_verify": "email_verify", "phone_verify": "phone_verify", "sign_up": "sign_up", "password_change": "password_change", "phone_change": "phone_change", "email_change": "email_change", "username_change": "username_change", "recover": "recover"

Responses

User account change verification with pin via email (anon)

Authorizations:
bearerAuth
header Parameters
Accept
string
Example: application/json

{{authid}}

User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.3
Request Body schema: multipart/form-data
email
string

One of phone, email or username required

change_type
string

"generic": "generic", "verify": "verify", "email_verify": "email_verify", "phone_verify": "phone_verify", "sign_up": "sign_up", "password_change": "password_change", "phone_change": "phone_change", "email_change": "email_change", "username_change": "username_change", "recover": "recover"

Responses

User account change verification with pin via phone

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g

{{authid}}

Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
phone
string

One of phone, email or username required

change_type
string

"generic": "generic", "verify": "verify", "email_verify": "email_verify", "phone_verify": "phone_verify", "sign_up": "sign_up", "password_change": "password_change", "phone_change": "phone_change", "email_change": "email_change", "username_change": "username_change", "recover": "recover"

Responses

User account change verification with pin via phone (anon)

Authorizations:
bearerAuth
header Parameters
Accept
string
Example: application/json

{{authid}}

User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.3
Request Body schema: multipart/form-data
phone
string

One of phone, email or username required

change_type
string

"sign_up": "verify", "password_change": "change-pwd", "phone_change": "change-phone", "username_change": "change-username", "email_change": "email-change"

Responses

User account activate/deactive

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: {{authep}}
authm
string
Example: {{authm}}
sid
string
Example: {{sid}}
Authorization
string
Example: Bearer abcdefgh
Content-Type
string
Example: application/json
Request Body schema: multipart/form-data
status
integer

0 or 1

Responses

User account delete/undelete

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
Request Body schema: multipart/form-data
status
integer

0 or 1

Responses

User account username update

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
email
username
string
current_password
string
pin
integer

Responses

User account email update

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
email
string

Current email (inferred from existing user data)

new_email
string

New email

phone
string

Current phone (inferred from existing user data) if used for the pin

email_type
string

primary or secondary

pin
integer

Generated after initiation

Responses

User account phone update

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
email
string

Email inferred from user account

new_phone
string

New phone number

phone
string
phone_type
string

primary or secondary

pin
integer

Responses

User account password update

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
email
string

Optional if that was used to request the code

current_password
string
new_password
string
pin
integer
phone
string

Optional if that was used to request the code

Responses

Update profile photo

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
files[]
string <binary>
oid
integer

Optional

Responses

User account info by authid

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

User account info by uid

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

User account username history

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses

User account check

Authorizations:
bearerAuth
query Parameters
username
string
Example: username=user

Optional

email
string

Optional

phone
string
Example: phone= 233244405239

Optional

header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

User account check basic

Authorizations:
bearerAuth
query Parameters
email
string

Optional

header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

User account username eligibility check

Authorizations:
bearerAuth
query Parameters
username
string
Example: username=ebem00099999

Optional

check
string
Example: check=duration

exists or duration

header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
token
string
Example: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDkwMzg0NjMsImlhdCI6MTcwOTAzODE2MywiYXV0aF90aW1lIjoxNzA5MDM4MDI2LCJqdGkiOiI2OWRiZWY5Yi03NzVjLTRiMTEtYTZlNS1jNzJiNGEzMWFlYWMiLCJpc3MiOiJodHRwczovL2F1dGguY2xhcHBuZXQuY29tOjg0NDMvcmVhbG1zL2NsYXBwbmV0IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjI0ZDQ3ODg2LTg0OGUtNDg0NS1hYjI2LWJlZTJhZDM5MThiNiIsInR5cCI6IkJlYXJlciIsImF6cCI6ImNwIiwic2Vzc2lvbl9zdGF0ZSI6IjEyMzAyNjQ2LTI5MGItNDM1YS04ZWVhLWZiNmM0YWYxMDJlZCIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiIsImRlZmF1bHQtcm9sZXMtY2xhcHBuZXQiXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Im9wZW5pZCBlbWFpbCBwcm9maWxlIiwic2lkIjoiMTIzMDI2NDYtMjkwYi00MzVhLThlZWEtZmI2YzRhZjEwMmVkIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsIm5hbWUiOiJFa293IFRheWxvciIsInByZWZlcnJlZF91c2VybmFtZSI6ImVrb3d0YXlsb3IiLCJsb2NhbGUiOiJlbiIsImdpdmVuX25hbWUiOiJFa293IiwiZmFtaWx5X25hbWUiOiJUYXlsb3IiLCJlbWFpbCI6ImVrb3d0YXlsb3JAb3V0bG9vay5jb20ifQ.j1rbwVwbVX00Uzk-gdw5n-ys7nt3eQaJC8Sn6JSxhiwmp2GstavWYnL--wNVGiRorwiGqogws1a1AhvF6Yymcld1SeH4Wkf7_YRMbFSkzmYXtzStiHwdeOHkz90U5KDJuDAlJ2h4CYlnAtUyHkXCOVHcpTIhSDZDsGpRZyqJOE09bFSr4bVaDeYlef-WtE51i_TjdGHsc70W_SpzksvKDbu3cOKGoocn_3lbSct5yDSIZyWUWVkpo8P9wSIUUHFtcHM-6NVGkGKi2yrnyyaNw5s9BrKpgn9Ror2Z5-g3RBZK2Fyfg4p3b73SFJ9ITQ2N-eHASObeUlGu_wWunx8V1w

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

sid
string
Example: fa201aa9-867e-4336-a710-fecf2d8ea96c
authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g

Responses

User account verify email hash

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}

Responses

User account verify initiate

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
phone
string

Optional

email
string

Responses

User account verify phone

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
Request Body schema: multipart/form-data
phone
string
pin
integer

Responses

User account verify email

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: c0f2c804-4ebe-4c42-aece-0c3be76a9fd4
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
email
string
pin
integer

Responses

User account password change email

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
Request Body schema: multipart/form-data
email
string

Responses

User account recover password

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
Request Body schema: multipart/form-data
email
string
phone
string

Optional depending on if email or phone was used for the recovery pin request

new_password
string
confirm_password
string
pin
integer

Responses

User account change password

Authorizations:
bearerAuth
header Parameters
authid
string
Example: {{authid}}
Request Body schema: multipart/form-data
email
string
current_password
string
new_password
string
pin
integer

Responses

User Account > Pin (personal)

User account pin check

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

User account pin set

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Request Body schema: multipart/form-data
email
string
password
string
pin
integer

Responses

User account pin reset

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
number
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36
string
Request Body schema: multipart/form-data
email
password
string
pin
integer

Responses

User account pin verify

Authorizations:
bearerAuth
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
Sid
string
Example: b503cdda-10da-4406-972f-859b432b53a7
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
User-Agent
string
Request Body schema: multipart/form-data
email
string
pin
integer

Responses

User Account > Pin (temp or verification)

User account temp pin check [dev]

Authorizations:
bearerAuth
query Parameters
email
string
header Parameters
Authorization
number
Example: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzBjNDU1ZC0zMWMwLTQ1NjEtYmFjNC00MTZlYWJhZDRlOWYifQ.eyJleHAiOjE3MjM1MjQwODIsImlhdCI6MTcyMzQ4ODA4MiwianRpIjoiNGU0YzhlOGYtNDdlZi00Y2FiLWFiZjUtZDQ1NjcxMDQ2OTk3IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5Iiwic3ViIjoiMmY2YWEyYzYtMzNhYy00NTA1LWIzY2EtMTM4M2E4MjM0NzQ0IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6IndlYiIsInNpZCI6IjQ1YTU3MDUzLTA1NWYtNDZmYi1iOTVmLTc1YTA2ODE1OTk2ZiIsInNjb3BlIjoib3BlbmlkIHdlYi1vcmlnaW5zIGJhc2ljIHByb2ZpbGUgcm9sZXMgZW1haWwgYWNyIn0.1Canw1MhbY_DFgq9M13PydZY9MpaZzhIX78ceynLzY91xJLsSRHOGmdI5FkCEBPco6FOt4KFqxVXG92JIDqg4g
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}
Authm
string
Example: local
Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

User Account > Organization

User account organizations

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json
Authorization
string
Example: Fxn_Post_Execute {{authToken}}

Responses

User Account > Engagements

Get engagements (with filters)

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Get engagements summary (with filters) Copy

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

User Account > Fingerprint

User account add open fingerprint

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e9736fd7-2d4c-45f5-b946-61eabe29385e

{{authid}}

nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "fp": {
    }
}

User account add pro fingerprint

Authorizations:
bearerAuth
header Parameters
authid
string
Example: afnadnfa-dakfjbkadjfb-dkjfbadkjbnfvgvgv

{{authid}}

nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "open_visitorId": "fakdjfkldjkfnlnl",
  • "fp": {
    },
  • "authanon": "example_anonymous_token_ABC123"
}

User Account > Geolocation

User account add geolocation

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e9736fd7-2d4c-45f5-b946-61eabe29385e

{{authid}}

nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "geo": {
    },
  • "authanon": ""
}

User Account > Metrics and Insights

User account stats

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authid
string
Example: {{authid}}
Sid
string
Example: {{sid}}

c0f2c804-4ebe-4c42-aece-0c3be76a9fd4

Authep
string
Example: Mqmvcl1mwTTGQPm0rvmE1VybP6KPVpmcsRBgJOrMcPA=
Accept
string
Example: application/json

Responses

User Account > Preferences

Get preferences

Authorizations:
bearerAuth
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Get preferences details

Authorizations:
bearerAuth
path Parameters
uaptid
required
integer
Example: 6
header Parameters
authid
string
Example: e26f8340-a635-4974-9074-eb380245e053
nonce
string
Example: VQVLNZQFjGXDRBuB_EMcpPchHC5AKdAfVWwsXqOtYl4
authep
string
Example: iLdRiQYBXCYqceigsiWnO8iiNC7x8qN0bO70ksQwUGY=
authm
string
Example: local
sid
string
Example: sid

Responses

Set user preference

Authorizations:
noauthAuth
path Parameters
uaptid
required
integer
Example: 6
header Parameters
authid
string
Example: {{authid}}
authep
string
Example: authep
sid
string
Example: {{sid}}
authm
string
Example: local
Authorization
string
Example: Fxn_Post_Execute {{AuthToken}}
Request Body schema: multipart/form-data
preference
integer

Responses

Versioning

Get GitInfo

Authorizations:
bearerAuth
header Parameters
Authm
string
Example: local
Authorization
string
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwUlFfQjVqTk92MHJCUUh3NHloRDRtWmRDbHNGdjFYWVdlYWtPZElVYWE4In0.eyJleHAiOjE3MjAxMDYyMjgsImlhdCI6MTcyMDEwNTkyOCwianRpIjoiODdmMmE0YTMtMTM3OS00MmYxLTk5MmEtYWJkOGQ2NjIwNmIzIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9mZWVseWZlZWx5IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjJmNmFhMmM2LTMzYWMtNDUwNS1iM2NhLTEzODNhODIzNDc0NCIsInR5cCI6IkJlYXJlciIsImF6cCI6IndlYiIsInNpZCI6IjYyMTQ0ZWNmLTE1YjktNGE3Zi1hN2JmLWE5MWFlY2QxYzRiZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLWZlZWx5ZmVlbHkiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IkViZW4gQ2hyaXNtYXMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJlYmVtMDAwOSIsImdpdmVuX25hbWUiOiJFYmVuIiwiZmFtaWx5X25hbWUiOiJDaHJpc21hcyIsImVtYWlsIjoiYXVycGhhbDIwMTJAZ21haWwuY29tIn0.yQkqg6WMlp0W50BYrYG01nLabedj6lzOCCnK93mOodhi-Vzlda0uFxtyiPM7SACYTkz82oJIa1jYZ6mtI9EnFqvDUTKffBiM70vU2TrOE_g7YyYCAH3Mqm0A5TXdEW1IAaocwyu388A-qQuB-lsEhXhc9lXxpwno9mQYA6WIFDglMCo6SqNsB_Ie6pPmG845pI65fNlKIN71H7U6HkkZSBetxnIBKM7pMcuvkHHJlomX-2A3NqkESAX44eQ9AR-WxdDMnI6UAFTJvWzVBbLtbvevzSBp5chV-iccOa5BOUSVWFin5n1ZMi-qQXe06dkkEU6f6uttlTH0OmRKPEOlxw
Authid
string
Example: 2f6aa2c6-33ac-4505-b3ca-1383a8234744
Sid
string
Example: e46594d1-ff54-4024-9609-f25a0b24a20a

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJyNXkyX3pHdEhBYlNxcEhEbFp5NzlFNG1NMVJKZUVSSFRJaXVNWC1qZTBjIn0.eyJleHAiOjE3MDYzMDg2MjcsImlhdCI6MTcwNjMwODMyNywianRpIjoiN2M0YzQ2OWEtNGNjMS00MzE5LTg4NDctYWE4MzU4OTcxNWI2IiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmNsYXBwbmV0LmNvbTo4NDQzL3JlYWxtcy9jbGFwcG5ldCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI4NmE5NmI0ZC03YjVmLTRiNWQtOGI4Ni1kYjdiY2VjNGJkZTIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjcCIsInNlc3Npb25fc3RhdGUiOiJjNGQ0Yzc4OS0zOGY1LTRlMDctOWM1MC1iYjYwZDE5YTE0YTIiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWNsYXBwbmV0Il19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6ImM0ZDRjNzg5LTM4ZjUtNGUwNy05YzUwLWJiNjBkMTlhMTRhMiIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiVGVzdCBUZXN0ZXIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0QG1haWwuY29tIiwiZ2l2ZW5fbmFtZSI6IlRlc3QiLCJmYW1pbHlfbmFtZSI6IlRlc3RlciIsImVtYWlsIjoidGVzdEBtYWlsLmNvbSJ9.nOlj42xvnAcMmSO7w_d9hc0Zry4m_TDrQtrJlhFWjVvm7eE0sZJ1fXfMkTx0fiXpGj6rVxSQ-I7CFzJnQQdVgBXxWNEle9WB39x63vOjuexb5lWh5oQwwCBFKtHWZFL0h5M_h_BkCK68QgE2DuHd-DTUwYnrBhKjORQzZOn03XnoE4GQQKReMjUdLwwli2KexKsrG5B3EoROf7hS7w-vk_IH6MkDZbMhGhmMljHhCeM8As8YuoMa2gaFAX0CIYco9pcw1OQlXsxfKT4DkwtUIHjUGMJEZ8q1_91LQMOX_8RADQCKVHaRqAblCzhI0mTjFmqqcXrFJIdoulunnfb9vQ

Authm
string
Example: local
Authep
string
Example: SggnS6oMVqTYgg41disU37dlNwtNjKkRvFIwJlnNdHg=
Accept
string
Example: application/json

Responses