openapi: 3.0.3
info:
title: Digitalsero
description: ''
version: 1.0.0
servers:
-
url: 'https://digitalsero-staging-api.b5digital.dk'
paths:
/api/access-requests/list:
get:
summary: 'List All AccessRequests'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- AccessRequests
/api/access-requests/send-email:
post:
summary: 'Send Email to Client with Access Request Link'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- AccessRequests
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
description: ''
example: '"b90eac01-12c1-4d3f-a0aa-df230c76fa79"'
email:
type: string
description: ''
example: hello@gmail.com
required:
- requestId
- email
/api/access-requests:
get:
summary: 'List AccessRequests For Datatable'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- AccessRequests
post:
summary: 'Add AccessRequest'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- AccessRequests
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
providers:
type: array
description: ''
example:
- []
items:
type: object
properties:
id:
type: string
description: ''
example: ut
businessManagerId:
type: string
description: 'This field is required when providers.*.id is META.'
example: null
businessManagerName:
type: string
description: 'This field is required when providers.*.id is META.'
example: null
email:
type: string
description: 'This field is required when providers.*.id is GOOGLE. Must be a valid email address.'
example: emmalee.damore@example.org
externalUserId:
type: string
description: 'This field is required when providers.*.id is LINKED_IN.'
example: null
businessCenterId:
type: string
description: 'This field is required when providers.*.id is TIKTOK.'
example: null
businessCenterName:
type: string
description: 'This field is required when providers.*.id is TIKTOK.'
example: null
assets:
type: array
description: ''
example:
- []
items:
type: object
properties:
type:
type: string
description: ''
example: soluta
role:
type: string
description: 'This field is required when providers.*.assets.*.manager is not present.'
example: qui
manager:
type: object
description: ''
example: []
properties:
id:
type: string
description: ''
example: non
name:
type: string
description: ''
example: minima
required:
- type
required:
- id
'/api/access-requests/{requestId}':
delete:
summary: 'Delete AccessRequest'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"message\": \"access_request deleted successfully\",\n \"data\": null,\n }\n }"
tags:
- AccessRequests
get:
summary: 'Show AccessRequest'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- AccessRequests
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
-
in: path
name: id
description: ''
example: '1'
required: true
schema:
type: string
'/api/access-requests/{requestId}/assets':
get:
summary: 'List Request assets for given providers'
description: ''
parameters:
-
in: query
name: providers
description: ''
example: 'META,GOOGLE'
required: true
schema:
type: string
description: ''
example: 'META,GOOGLE'
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Request assets listed successfully'
data:
-
id: GOOGLE
types:
-
type: GOOGLE_ADS
assets:
-
id: 1
name: 'Google Ads Account'
error: ''
properties:
message:
type: string
example: 'Request assets listed successfully'
data:
type: array
example:
-
id: GOOGLE
types:
-
type: GOOGLE_ADS
assets:
-
id: 1
name: 'Google Ads Account'
error: ''
items:
type: object
tags:
- AccessRequests
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
providerIds:
type: array
description: ''
example:
- illo
items:
type: string
required:
- providerIds
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
'/api/access-requests/{requestId}/grant-access':
post:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- AccessRequests
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
description: validation.uuid.
example: a245cd48-593e-38fb-a568-092dfa512b09
providers:
type: array
description: ''
example:
- []
items:
type: object
properties:
id:
type: string
description: ''
example: beatae
assetTypes:
type: array
description: ''
example:
- []
items:
type: object
properties:
type:
type: string
description: ''
example: nemo
assets:
type: array
description: ''
example:
- []
items:
type: object
properties:
id:
type: string
description: 'Must not be greater than 50 characters.'
example: imj
name:
type: string
description: 'Must not be greater than 255 characters.'
example: pbelnlocjgflyjepchxrbximpabuuwivyjzebrfrmwgghmlvjhpoikgqwmjp
businessCenterId:
type: string
description: 'This field is required when providers.*.id is TIKTOK. Must not be greater than 50 characters.'
example: xuhcg
business:
type: object
description: ''
example: []
properties:
id: { type: string, description: 'Must not be greater than 50 characters.', example: phlwiqkdsy }
name: { type: string, description: 'Must not be greater than 255 characters.', example: hhvfpvwzepurkjgnxbiuauggojlhytvthvmwvjiovctwqwwngrgwykajryznekhssjchssdvvc }
required:
- id
required:
- type
required:
- id
required:
- requestId
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
'/api/access-requests/{requestId}/clone':
post:
summary: 'Clone Access Request'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- AccessRequests
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
-
in: path
name: id
description: ''
example: '1'
required: true
schema:
type: string
'/api/access-requests/{requestId}/request-access':
post:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- AccessRequests
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
description: validation.uuid.
example: 5af8c43c-176e-3472-ba65-1f037655e9ac
providers:
type: array
description: ''
example:
- []
items:
type: object
properties:
id:
type: string
description: ''
example: qui
assetTypes:
type: array
description: ''
example:
- []
items:
type: object
properties:
type:
type: string
description: ''
example: culpa
assets:
type: array
description: ''
example:
- []
items:
type: object
properties:
id:
type: string
description: 'Must not be greater than 50 characters.'
example: tquiwziboxhblfaiaalntbym
name:
type: string
description: 'Must not be greater than 255 characters.'
example: pbyntabxrvmhvntaojtvhckaxnwhoccizqsrizccxtsqzqfzatwxdgoepbptztbntqvawwsfvjnapbnezgjrjtajppxbnuuvgcrhmzzjckljixdfjcvaxlntcqkhprpgkycaghfpq
businessCenterId:
type: string
description: 'This field is required when providers.*.id is TIKTOK. Must not be greater than 50 characters.'
example: la
business:
type: object
description: ''
example: []
properties:
id: { type: string, description: 'Must not be greater than 50 characters.', example: uvytmfdjlhimibpzpletbhzekdjzhtcnqjvzkkcdnqzf }
name: { type: string, description: 'Must not be greater than 255 characters.', example: vrjpfoiiphwczwzhpeffuwomteztajskigvnbngfbffbzehlptismelghxkvufvyasqzbxdicm }
required:
- id
required:
- type
required:
- id
required:
- requestId
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
/api/agencies/me:
get:
summary: 'Agency profile'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Agencies
put:
summary: 'Update My Agency'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Agencies
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: 'Agency name'
whitelabellingEnabled:
type: boolean
description: ''
example: true
fontColor:
type: string
description: ''
example: '#fff'
whitelabellingSettings:
type: object
description: ''
example: []
properties:
primaryColor:
type: string
description: 'This field is required when whitelabellingEnabled is true.'
example: null
backgroundColor:
type: string
description: 'This field is required when whitelabellingEnabled is true.'
example: null
headerColor:
type: string
description: 'This field is required when whitelabellingEnabled is true.'
example: null
darkPrimaryColor:
type: string
description: 'This field is required when whitelabellingEnabled is true.'
example: null
invertColor:
type: boolean
description: 'This field is required when whitelabellingEnabled is true.'
example: false
isDark:
type: boolean
description: 'This field is required when whitelabellingEnabled is true.'
example: true
logo:
type: string
description: 'This field is required when whitelabellingEnabled is true.'
example: null
subdomainEnabled:
type: boolean
description: ''
example: true
subdomain:
type: string
description: 'This field is required when subdomainEnabled is true.'
example: null
primaryColor:
type: string
description: ''
example: '#fff'
backgroundColor:
type: string
description: ''
example: '#fff'
/api/agencies/me/logo:
post:
summary: 'Update My Agency logo'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: multipart/form-data
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Agencies
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
logo:
type: string
format: binary
description: ''
/api/agencies:
get:
summary: 'List Agencies For Datatable'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Agencies
/api/agencies/invite:
post:
summary: 'Invite Agency'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Agencies
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 100 characters.'
example: sneciepekknasekrcunhpzrnlxxxtytthwukeuyjqbjvcjusslg
primaryColor:
type: string
description: ''
example: null
fontColor:
type: string
description: ''
example: null
backgroundColor:
type: string
description: ''
example: null
subdomain:
type: string
description: ''
example: null
admin:
type: object
description: ''
example: []
properties:
name:
type: string
description: 'Must not be greater than 100 characters.'
example: dgzvimcdr
email:
type: string
description: 'Must be a valid email address. Must not be greater than 254 characters.'
example: cpmaxcmjdqvacjzyohdetuvcompavrtrwjldcsqjrnkkszpsydjetpkuaqmjdnzlvrlnbpnbvwkmggxctphkkzycwquowycvfbbvdzwryiletwdzcrgsvdcbtbqixcdzxgmyjlzczsaqxiubuwtptvuacfezvtkvvuxqtzkhpxldfjjmlmhdlbtnfeorhzxnkjilhwpceqma
password:
type: string
description: ''
example: dolorum
/api/agencies/me/logo/remove:
post:
summary: 'Remove My Agency logo'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Agencies
/api/agencies/me/billing-info:
put:
summary: 'Update agency billing information'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Checkout Done Successfully'
data:
session:
id: bps_1MgldOHlSdZh4mNSiP8XGd3x
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677661658
customer: cus_NMn44Vx47uPaeq
flow: null
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUmV4VTNPQk9MUW5sOERmeWdoUm5ZS25WQnVuVHNY0100DR7sNYlu/subscriptions/sub_1Mc3VxHlSdZh4mNSvm8UtsKo/preview/price_1MdaF1HlSdZh4mNSyrCsx8Bw'
properties:
message:
type: string
example: 'Checkout Done Successfully'
data:
type: object
example:
session:
id: bps_1MgldOHlSdZh4mNSiP8XGd3x
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677661658
customer: cus_NMn44Vx47uPaeq
flow: null
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUmV4VTNPQk9MUW5sOERmeWdoUm5ZS25WQnVuVHNY0100DR7sNYlu/subscriptions/sub_1Mc3VxHlSdZh4mNSvm8UtsKo/preview/price_1MdaF1HlSdZh4mNSyrCsx8Bw'
tags:
- Agencies
/api/auth/forgot-password:
post:
summary: 'Forget Password'
description: 'Send a reset link to the given user.'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"We have e-mailed your password reset link!\",\n}"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: ''
example: admin@b5digital.dk
required:
- email
security: []
/api/auth/reset-password:
post:
summary: 'Reset Password'
description: "Reset the given user's password."
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Your password has been reset!\",\n}"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: ''
example: et
email:
type: string
description: ''
example: admin@b5digital.dk
password:
type: string
description: ''
example: password
password_confirmation:
type: string
description: ''
example: password
required:
- token
- email
- password
- password_confirmation
security: []
/api/auth/register:
post:
summary: Register
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: john
email:
type: string
description: ''
example: john@b5digital.dk
password:
type: string
description: ''
example: aaA1$2211
password_confirmation:
type: string
description: ''
example: aaA1$2211
required:
- name
- email
- password
- password_confirmation
security: []
/api/auth/create-testing-token:
post:
summary: 'Create Testing Token'
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"access_token\": \"<>\",\n }\n }"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: ''
example: admin@b5digital.dk
password:
type: string
description: ''
example: aaA1$2211
roleId:
type: string
description: ''
example: '"AGENCY_ADMIN" fetched from List Roles API'
required:
- email
- password
- roleId
security: []
/api/auth/change-password:
post:
summary: 'Change Password'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"message\": \"Password has been changed successfully\",\n \"data\": null,\n }\n }"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
old_password:
type: string
description: ''
example: password
new_password:
type: string
description: ''
example: '123456789'
new_password_confirmation:
type: string
description: ''
example: '123456789'
required:
- old_password
- new_password
- new_password_confirmation
'/api/social-login/{providerId}':
get:
summary: 'Generate RedirectUrl to your different providers.'
description: ''
parameters:
-
in: query
name: userType
description: ''
example: CLIENT/PARTNER
required: true
schema:
type: string
description: ''
example: CLIENT/PARTNER
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Redirect Link Generated Successfully\"\n \"data\": {\n \"redirectUrl\": \"{provider-redirect-url}\"\n }\n }"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
providerId:
type: string
description: ''
example: impedit
userType:
type: string
description: ''
example: accusamus
requestId:
type: string
description: 'This field is required when userType is CLIENT.'
example: null
socialAction:
type: string
description: 'This field is required when userType is CLIENT.'
example: null
required:
- providerId
- userType
security: []
parameters:
-
in: path
name: providerId
description: ''
example: META
required: true
schema:
type: string
'/api/social-login/{providerId}/callback':
get:
summary: 'Handle callback from your provider. add user to system and login if not logged in yet.'
description: ''
parameters:
-
in: query
name: userType
description: ''
example: CLIENT/PARTNER
required: true
schema:
type: string
description: ''
example: CLIENT/PARTNER
-
in: query
name: code
description: ''
example: et
required: true
schema:
type: string
description: ''
example: et
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Connected Successfully\"\n \"data\": null\n }"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
providerId:
type: string
description: ''
example: voluptatum
userType:
type: string
description: ''
example: quis
requestId:
type: string
description: 'This field is required when userType is CLIENT.'
example: null
socialAction:
type: string
description: 'This field is required when userType is CLIENT.'
example: null
required:
- providerId
- userType
security: []
parameters:
-
in: path
name: providerId
description: ''
example: META
required: true
schema:
type: string
/api/auth/login:
post:
summary: Login
description: "To authenticate your SPA,\nyour SPA's \"login\" page should first make a request to the `/sanctum/csrf-cookie` endpoint\nto initialize CSRF protection for the application."
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"message\": \"You have logged in successfully\",\n \"data\": null,\n }\n }"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: ''
example: admin@b5digital.dk
password:
type: string
description: ''
example: aaA1$2211
roleId:
type: string
description: ''
example: null
required:
- email
- password
security: []
/api/auth/logout:
post:
summary: Logout
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"message\": \"You have logged out successfully\",\n \"data\": null,\n }\n }"
tags:
- Auth
security: []
'/api/auth/email/resend-verification/{user_slug}':
post:
summary: 'Resend Email Verification.'
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Verification email sent.'
properties:
message:
type: string
example: 'Verification email sent.'
tags:
- Auth
security: []
parameters:
-
in: path
name: user_slug
description: 'The slug of the user.'
example: admin
required: true
schema:
type: string
-
in: path
name: slug
description: ''
example: user-name
required: true
schema:
type: string
'/api/auth/email/verify/{user_slug}':
get:
summary: 'Verify email.'
description: ''
parameters:
-
in: query
name: expires
description: ''
example: 165623434
required: true
schema:
type: integer
description: ''
example: 165623434
-
in: query
name: hash
description: ''
example: 35a3e83c342877e48bb249d6979b0f46aeb4d5ec
required: true
schema:
type: string
description: ''
example: 35a3e83c342877e48bb249d6979b0f46aeb4d5ec
-
in: query
name: signature
description: ''
example: 095ff82b52815772a9ea9e2f505e46546a684a1b0df11bc23a3f5857e177f0a8
required: true
schema:
type: string
description: ''
example: 095ff82b52815772a9ea9e2f505e46546a684a1b0df11bc23a3f5857e177f0a8
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Email Verified'
properties:
message:
type: string
example: 'Email Verified'
tags:
- Auth
security: []
parameters:
-
in: path
name: user_slug
description: 'The slug of the user.'
example: admin
required: true
schema:
type: string
-
in: path
name: slug
description: ''
example: employee
required: true
schema:
type: string
'/api/demo/access-requests/{requestId}':
get:
summary: 'View AccessRequest As Demo'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- DemoAccessRequests
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
-
in: path
name: id
description: ''
example: '"f30b450a-817e-4106-a933-2659b35f2502"'
required: true
schema:
type: string
'/api/demo/access-requests/{requestId}/assets':
get:
summary: 'List Request assets for given providers'
description: ''
parameters:
-
in: query
name: providers
description: ''
example: 'META,GOOGLE'
required: true
schema:
type: string
description: ''
example: 'META,GOOGLE'
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Request assets listed successfully'
data:
-
id: GOOGLE
types:
-
type: GOOGLE_ADS
assets:
-
id: 1
name: 'Google Ads Account'
error: ''
properties:
message:
type: string
example: 'Request assets listed successfully'
data:
type: array
example:
-
id: GOOGLE
types:
-
type: GOOGLE_ADS
assets:
-
id: 1
name: 'Google Ads Account'
error: ''
items:
type: object
tags:
- DemoAccessRequests
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
providerIds:
type: array
description: ''
example:
- amet
items:
type: string
required:
- providerIds
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
'/api/demo/access-requests/{requestId}/grant-access':
post:
summary: 'Grant dummy access to certain request'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- DemoAccessRequests
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
description: validation.uuid.
example: 57497559-260d-3571-825c-923316fd60dd
providers:
type: array
description: ''
example:
- []
items:
type: object
properties:
id:
type: string
description: ''
example: doloribus
assetTypes:
type: array
description: ''
example:
- []
items:
type: object
properties:
type:
type: string
description: ''
example: omnis
assets:
type: array
description: ''
example:
- []
items:
type: object
properties:
id:
type: string
description: 'Must not be greater than 50 characters.'
example: hanp
name:
type: string
description: 'Must not be greater than 255 characters.'
example: nexegydaojkrpaddwltpmppdjiebqqtwljnevfbdrullgkrlqwlxeipawoppmngajjkszpkrylpowbelgdjcwriaaw
businessCenterId:
type: string
description: 'This field is required when providers.*.id is TIKTOK. Must not be greater than 50 characters.'
example: fmxnggqww
required:
- id
required:
- type
required:
- id
required:
- requestId
parameters:
-
in: path
name: requestId
description: ''
example: 01a9af28-3ee1-4529-8a79-af6f5a447ba9
required: true
schema:
type: string
/api/configurations:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
sessionLifetime: '600'
fe_build_version: '21'
properties:
sessionLifetime:
type: string
example: '600'
fe_build_version:
type: string
example: '21'
tags:
- Endpoints
security: []
/api/configurations/fe-version/increment:
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
security: []
/api/social-providers/google/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/social-providers/google/analytics-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/social-providers/google/business-profile-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/social-providers/google/tag-manager-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/social-providers/google/search-console:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/demo/social-providers/google/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/demo/social-providers/google/analytics-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/demo/social-providers/google/business-profile-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/demo/social-providers/google/tag-manager-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/demo/social-providers/google/search-console:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/social-providers/google/merchant:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/demo/social-providers/google/merchant:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/social-providers/google/ads/mcc:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Google
/api/admin/insights/agencies/verified:
get:
summary: 'Get Total Verified Agencies'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
count: 7
properties:
count:
type: integer
example: 7
tags:
- Insights
/api/admin/insights/agencies/not-verified:
get:
summary: 'Get Total Not Verified Agencies'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
count: 1
properties:
count:
type: integer
example: 1
tags:
- Insights
/api/admin/insights/requests/all:
get:
summary: 'Get Total Sent Requests'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
count: 7
properties:
count:
type: integer
example: 7
tags:
- Insights
/api/admin/insights/agencies/requests:
get:
summary: 'Get Total Requests Per Agency'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
average_requests: 2
total_requests_per_agency:
-
name: Marwan
requests: 73
properties:
average_requests:
type: integer
example: 2
total_requests_per_agency:
type: array
example:
-
name: Marwan
requests: 73
items:
type: object
tags:
- Insights
/api/admin/insights/prices:
get:
summary: 'Get Total Plans'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"totalSubscriptions\": 3,\n\"total_subscriptions_per_price\": [\n {\n \"name\": \"R prod\",\n \"subscriptions\": 1,\n \"percentage\": 33\n },\n]\n}"
tags:
- Insights
/api/admin/insights/requests/pending:
get:
summary: 'Get Total Pending Requests'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
count: 5
properties:
count:
type: integer
example: 5
tags:
- Insights
/api/admin/insights/requests/completed:
get:
summary: 'Get Total Granted Requests'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
granted_count: 7
properties:
granted_count:
type: integer
example: 7
tags:
- Insights
/api/admin/insights/requests/in-progress:
get:
summary: 'Get Total Pending Requests'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
count: 5
properties:
count:
type: integer
example: 5
tags:
- Insights
/api/invoices/list:
get:
summary: 'List All Invoices'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:46.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:46.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
properties:
data:
type: array
example:
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:46.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:46.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
items:
type: object
tags:
- Invoices
/api/invoices:
get:
summary: 'List Invoices For Datatable'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:44.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:44.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
draw: '0'
recordsTotal: '1'
recordsFiltered: '1'
properties:
data:
type: array
example:
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:44.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
-
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:44.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
items:
type: object
draw:
type: string
example: '0'
recordsTotal:
type: string
example: '1'
recordsFiltered:
type: string
example: '1'
tags:
- Invoices
'/api/invoices/{id}':
get:
summary: 'Show Invoice'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:46.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
properties:
data:
type: object
example:
id: 1
amount_due: 0
amount_remaining: 0
amount_paid: null
currency: $
status: null
account_name: null
billing_reason: manual
description: 'Over Usage Charge'
paid: null
fileName: DigitalSero_25-03-2024_
created_at: '2024-03-25T11:19:46.000000Z'
invoice_items:
-
id: 1
invoice_id: 1
price_id: 14
amount: 0
currency: usd
description: '1 × Free (at $0.00 / month)'
period_start: 12-04-2023
period_end: 12-05-2023
created_at: '12-04-2023 12:57:44'
updated_at: '12-04-2023 12:57:44'
agency:
name: name
email: defaultplan@email.com
subdomainEnabled: 0
shouldApplySubdomain: false
subdomain: demotest
subdomainHistory:
- demotest
whitelabellingEnabled: 0
shouldApplyWhitelabelling: false
fontColor: null
logo: null
stripe_id: cus_NhS97iBazpeg5u
subscriberType: early-adopter
subscriberValue: null
paymentChannel: customer_portal
billing_information:
name: defaultplan
email: defaultplan@email.com
phone: null
address: null
taxIds: []
whitelabellingSettings:
backgroundColor: null
primaryColor: null
isDark: null
invertColor: null
headerColor: null
darkPrimaryColor: null
current_subscription:
id: 268
name: xxxxxx
requests_count: 0
usage: 0
overusage: 0
allow_overuse: 0
stripe_id: sub_1Ol9qFHbOaBUtWUKzHGvWszH
stripe_status: active
quantity: 1
trial_ends_at: null
current_period_start: '2024-03-18T12:51:35.000000Z'
current_period_end: '2024-04-18T12:51:35.000000Z'
price:
id: 14
stripe_id: price_1MbNIwHbOaBUtWUKkMOTZN4v
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '10'
created_at: '2023-04-12T12:46:57.000000Z'
product:
id: 7
stripe_id: prod_NM5Tfzq9jamT74
name: Free
description: 'Free Plan , Default for all new subscribers '
private: 1
active: 1
default: 1
default_price: price_1MbNIwHbOaBUtWUKkMOTZN4v
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '10'
users_number: '5'
whitelabelling: 0
subdomain: 0
allow_overuse: 0
allow_multiple_social_accounts_per_provider: 0
extra_price: null
ends_at: null
created_at: '2024-02-18T12:51:35.000000Z'
createdAt: '2023-04-12T12:57:15.000000Z'
updatedAt: '2024-02-18T12:51:35.000000Z'
tags:
- Invoices
parameters:
-
in: path
name: id
description: ''
example: 1
required: true
schema:
type: integer
'/api/invoices/{id}/download':
post:
summary: 'Download Invoice'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Invoices
parameters:
-
in: path
name: id
description: ''
example: 1
required: true
schema:
type: integer
/api/social-providers/linked_in/pages:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- LinkedIn
/api/social-providers/linked_in/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- LinkedIn
/api/social-providers/linked_in/pages/check-status:
post:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- LinkedIn
/api/demo/social-providers/linked_in/pages:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- LinkedIn
/api/demo/social-providers/linked_in/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- LinkedIn
/api/social-providers/meta/business-managers:
get:
summary: 'List Business Managers'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Business managers listed successfully\"\n \"data\": [\n {\n \"id\": \"12121212121\",\n \"name\": \"Manager name\"\n }\n ]\n }"
tags:
- Meta
post:
summary: 'Create Business Managers'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Business managers created successfully\"\n \"data\": [\n {\n \"id\": \"12121212121\",\n \"name\": \"Manager name\"\n }\n ]\n }"
tags:
- Meta
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: test
example: aut
industry:
type: string
description: ADVERTISING
example: facere
required:
- name
- industry
/api/social-providers/meta/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/social-providers/meta/pages:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/social-providers/meta/product-catalogs:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/demo/social-providers/meta/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/demo/social-providers/meta/pages:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/demo/social-providers/meta/product-catalogs:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/social-providers/meta/business-managers/industries:
get:
summary: 'List Industries'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": [\n \"ADVERTISING\",\n \"AUTOMOTIVE\",\n ]\n }"
tags:
- Meta
/api/social-providers/meta/business-managers/currencies:
get:
summary: 'List Currencies'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": [\n \"USD\",\n \"EUR\",\n ]\n }"
tags:
- Meta
/api/social-providers/meta/pixels:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/demo/social-providers/meta/pixels:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/social-providers/meta/instagram-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/demo/social-providers/meta/instagram-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Meta
/api/payment-methods:
get:
summary: 'List PaymentMethods For Datatable'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
draw: '0'
recordsTotal: '1'
recordsFiltered: '1'
properties:
data:
type: array
example:
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
items:
type: object
draw:
type: string
example: '0'
recordsTotal:
type: string
example: '1'
recordsFiltered:
type: string
example: '1'
tags:
- PaymentMethods
/api/payment-methods/list:
get:
summary: 'List All PaymentMethods'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
properties:
data:
type: array
example:
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
-
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
items:
type: object
tags:
- PaymentMethods
'/api/payment-methods/{id}':
get:
summary: 'Show UserPaymentMethod'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
properties:
data:
type: object
example:
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
tags:
- PaymentMethods
delete:
summary: 'Delete UserPaymentMethod'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"message\": \"payment_method deleted successfully\",\n \"data\": null,\n }\n }"
tags:
- PaymentMethods
parameters:
-
in: path
name: id
description: ''
example: 1
required: true
schema:
type: integer
/api/payment-methods/mark-as-default:
post:
summary: 'Mark Payment Method As Default'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Great!. Your Default Payment Method Is Saved.'
data: null
properties:
message:
type: string
example: 'Great!. Your Default Payment Method Is Saved.'
data:
type: string
example: null
tags:
- PaymentMethods
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
payment_method_id:
type: integer
description: ''
example: 1
required:
- payment_method_id
/api/payment-methods/validate-store:
post:
summary: 'Validate Add UserPaymentMethod'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: multipart/form-data
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
message: 'payment_method have created successfully'
properties:
data:
type: object
example:
id: 4
stripe_id: pm_1Mw4PMHbOaBUtWUKkIb2izJs
name: null
postal_code: null
is_default: 1
type: card
card:
brand: visa
last4: '4242'
country: US
exp_year: 2035
exp_month: 12
created_at: '2023-04-12T14:12:26.000000Z'
message:
type: string
example: 'payment_method have created successfully'
tags:
- PaymentMethods
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
payment_method_data:
type: array
description: ''
example:
- molestiae
items:
type: string
required:
- payment_method_data
/api/payment-methods/checkout-session:
post:
summary: 'Create Checkout Session'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Checkout Done Successfully'
data:
session:
id: cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz
object: checkout.session
after_expiration: null
allow_promotion_codes: null
amount_subtotal: 250
amount_total: 250
automatic_tax:
enabled: false
status: null
billing_address_collection: null
cancel_url: 'http://192.168.56.56/subscriptions?succeeded=0'
client_reference_id: null
consent: null
consent_collection: null
currency: usd
customer: cus_MIuXULsVAov3Pv
customer_creation: null
customer_details:
address: null
email: kepef@mailinator.com
name: null
phone: null
tax_exempt: null
tax_ids: null
customer_email: null
expires_at: 1661790807
livemode: false
locale: null
metadata: []
mode: subscription
payment_intent: null
payment_link: null
payment_method_collection: always
payment_method_options: null
payment_method_types:
- card
payment_status: unpaid
phone_number_collection:
enabled: false
recovered_from: null
setup_intent: null
shipping: null
shipping_address_collection: null
shipping_options: []
shipping_rate: null
status: open
submit_type: null
subscription: null
success_url: 'http://192.168.56.56/subscriptions?succeeded=1'
total_details:
amount_discount: 0
amount_shipping: 0
amount_tax: 0
url: 'https://checkout.stripe.com/pay/cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz#fidkdWxOYHwnPyd1blpxYHZxWnM1SFYxSWxob0dxT1ZwZHBKNEwwT3w0QycpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl'
properties:
message:
type: string
example: 'Checkout Done Successfully'
data:
type: object
example:
session:
id: cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz
object: checkout.session
after_expiration: null
allow_promotion_codes: null
amount_subtotal: 250
amount_total: 250
automatic_tax:
enabled: false
status: null
billing_address_collection: null
cancel_url: 'http://192.168.56.56/subscriptions?succeeded=0'
client_reference_id: null
consent: null
consent_collection: null
currency: usd
customer: cus_MIuXULsVAov3Pv
customer_creation: null
customer_details:
address: null
email: kepef@mailinator.com
name: null
phone: null
tax_exempt: null
tax_ids: null
customer_email: null
expires_at: 1661790807
livemode: false
locale: null
metadata: []
mode: subscription
payment_intent: null
payment_link: null
payment_method_collection: always
payment_method_options: null
payment_method_types:
- card
payment_status: unpaid
phone_number_collection:
enabled: false
recovered_from: null
setup_intent: null
shipping: null
shipping_address_collection: null
shipping_options: []
shipping_rate: null
status: open
submit_type: null
subscription: null
success_url: 'http://192.168.56.56/subscriptions?succeeded=1'
total_details:
amount_discount: 0
amount_shipping: 0
amount_tax: 0
url: 'https://checkout.stripe.com/pay/cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz#fidkdWxOYHwnPyd1blpxYHZxWnM1SFYxSWxob0dxT1ZwZHBKNEwwT3w0QycpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl'
tags:
- PaymentMethods
/api/payment-methods/customer-portal-session:
post:
summary: 'Create Customer Portal Session'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Checkout Done Successfully'
data:
session:
id: bps_1MgUShHlSdZh4mNS2OVJRKpR
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677595647
customer: cus_NMltWmnoFS1rj2
flow:
after_completion:
hosted_confirmation: null
redirect:
return_url: 'https://digitalsero-backend.test/subscriptions'
type: redirect
subscription_cancel: null
type: payment_method_update
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUk5EOVVGVGpxcERCdlZJTUJEVXAzUGdlNVRzckRO0100LsXIBIa6/flow'
properties:
message:
type: string
example: 'Checkout Done Successfully'
data:
type: object
example:
session:
id: bps_1MgUShHlSdZh4mNS2OVJRKpR
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677595647
customer: cus_NMltWmnoFS1rj2
flow:
after_completion:
hosted_confirmation: null
redirect:
return_url: 'https://digitalsero-backend.test/subscriptions'
type: redirect
subscription_cancel: null
type: payment_method_update
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUk5EOVVGVGpxcERCdlZJTUJEVXAzUGdlNVRzckRO0100LsXIBIa6/flow'
tags:
- PaymentMethods
/api/prices/list:
get:
summary: 'List All Prices'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
stripe_id: price_1MrHyfHbOaBUtWUKvgBI6L4F
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '250'
created_at: '2023-04-12T12:46:56.000000Z'
product:
id: 1
stripe_id: prod_NcX2BPo03bIEN1
name: 'Early launch plan'
description: null
private: 1
active: 0
default: 0
default_price: price_1MrHyfHbOaBUtWUKvgBI6L4F
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '250'
users_number: INF
whitelabelling: 1
subdomain: 1
allow_overuse: 1
allow_multiple_social_accounts_per_provider: 0
extra_price: null
-
id: 1
stripe_id: price_1MrHyfHbOaBUtWUKvgBI6L4F
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '250'
created_at: '2023-04-12T12:46:56.000000Z'
product:
id: 1
stripe_id: prod_NcX2BPo03bIEN1
name: 'Early launch plan'
description: null
private: 1
active: 0
default: 0
default_price: price_1MrHyfHbOaBUtWUKvgBI6L4F
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '250'
users_number: INF
whitelabelling: 1
subdomain: 1
allow_overuse: 1
allow_multiple_social_accounts_per_provider: 0
extra_price: null
properties:
data:
type: array
example:
-
id: 1
stripe_id: price_1MrHyfHbOaBUtWUKvgBI6L4F
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '250'
created_at: '2023-04-12T12:46:56.000000Z'
product:
id: 1
stripe_id: prod_NcX2BPo03bIEN1
name: 'Early launch plan'
description: null
private: 1
active: 0
default: 0
default_price: price_1MrHyfHbOaBUtWUKvgBI6L4F
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '250'
users_number: INF
whitelabelling: 1
subdomain: 1
allow_overuse: 1
allow_multiple_social_accounts_per_provider: 0
extra_price: null
-
id: 1
stripe_id: price_1MrHyfHbOaBUtWUKvgBI6L4F
amount: 0
hasDiscount: false
amountBeforeDiscount: 0
package_quantity: null
billing_scheme: per_unit
currency: $
interval: month
interval_count: '1'
requests_number: '250'
created_at: '2023-04-12T12:46:56.000000Z'
product:
id: 1
stripe_id: prod_NcX2BPo03bIEN1
name: 'Early launch plan'
description: null
private: 1
active: 0
default: 0
default_price: price_1MrHyfHbOaBUtWUKvgBI6L4F
associated_providers:
- GOOGLE
- META
- LINKED_IN
- TIKTOK
requests_number: '250'
users_number: INF
whitelabelling: 1
subdomain: 1
allow_overuse: 1
allow_multiple_social_accounts_per_provider: 0
extra_price: null
items:
type: object
tags:
- Prices
/api/products/social-providers:
get:
summary: 'List Product Social Providers'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Social Providers listed successfully\"\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"META\"\n }\n ]\n }"
tags:
- Products
/api/promotions/check-active:
get:
summary: 'Check promotion is active by subscriber type'
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Promotion is active\"\n \"data\": null\n }"
tags:
- Promotions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
subscriber:
type: string
description: ''
example: et
required:
- subscriber
security: []
/api/roles:
get:
summary: 'List All User Roles'
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
id: SUPER_ADMIN
name: 'Super Admin'
-
id: SUPER_ADMIN
name: 'Super Admin'
properties:
data:
type: array
example:
-
id: SUPER_ADMIN
name: 'Super Admin'
-
id: SUPER_ADMIN
name: 'Super Admin'
items:
type: object
tags:
- 'Roles & Permissions'
security: []
/api/social-providers:
get:
summary: 'List Social Providers'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Social Providers listed successfully\"\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"META\"\n }\n ]\n }"
tags:
- SocialProviders
/api/social-providers/assets/validate:
post:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- SocialProviders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
description: validation.uuid.
example: c939ce89-0075-3a7e-95b9-4c2aeac3aabd
providerId:
type: string
description: ''
example: sapiente
assetTypeId:
type: string
description: ''
example: quisquam
assetId:
type: string
description: ''
example: cumque
parentId:
type: string
description: ''
example: sit
required:
- requestId
- providerId
- assetTypeId
- assetId
/api/demo/social-providers/assets/validate:
post:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- SocialProviders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
description: validation.uuid.
example: 2ec44954-2ceb-3d37-8256-2b07e16509d8
providerId:
type: string
description: ''
example: quae
assetTypeId:
type: string
description: ''
example: sequi
assetId:
type: string
description: ''
example: dolore
parentId:
type: string
description: ''
example: fugiat
required:
- requestId
- providerId
- assetTypeId
- assetId
/api/subscriptions/cancel:
post:
summary: 'Cancel Subscription'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: multipart/form-data
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n 'data': {\n 'message': 'subscription Canceled successfully',\n 'data': null,\n }\n }"
tags:
- Subscriptions
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
subscription_id:
type: integer
description: ''
example: 1
required:
- subscription_id
/api/subscriptions/cancel/customer-portal-session:
post:
summary: 'Create Customer Portal Session to cancel subscription'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Portal Done Successfully'
data:
session:
id: bps_1MgUlIHlSdZh4mNSw4ghwsEd
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677596800
customer: cus_NMltWmnoFS1rj2
flow:
after_completion:
hosted_confirmation: null
redirect:
return_url: 'https://digitalsero-backend.test/subscriptions'
type: redirect
subscription_cancel:
subscription: sub_1MgUjqHlSdZh4mNSiQIHKfxb
type: subscription_cancel
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUk5XV1FwNmFDMld6TGpXMndGdXBibk5XdERSV2FQ0100cyUik2du/flow'
properties:
message:
type: string
example: 'Portal Done Successfully'
data:
type: object
example:
session:
id: bps_1MgUlIHlSdZh4mNSw4ghwsEd
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677596800
customer: cus_NMltWmnoFS1rj2
flow:
after_completion:
hosted_confirmation: null
redirect:
return_url: 'https://digitalsero-backend.test/subscriptions'
type: redirect
subscription_cancel:
subscription: sub_1MgUjqHlSdZh4mNSiQIHKfxb
type: subscription_cancel
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUk5XV1FwNmFDMld6TGpXMndGdXBibk5XdERSV2FQ0100cyUik2du/flow'
tags:
- Subscriptions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
subscription_id:
type: string
description: ''
example: fuga
required:
- subscription_id
/api/subscriptions/charge-extra-usage/checkout-session:
post:
summary: 'Create Checkout Session for charge extra usage'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Checkout Done Successfully'
data:
session:
id: cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz
object: checkout.session
after_expiration: null
allow_promotion_codes: null
amount_subtotal: 250
amount_total: 250
automatic_tax:
enabled: false
status: null
billing_address_collection: null
cancel_url: 'http://192.168.56.56/subscriptions?succeeded=0'
client_reference_id: null
consent: null
consent_collection: null
currency: usd
customer: cus_MIuXULsVAov3Pv
customer_creation: null
customer_details:
address: null
email: kepef@mailinator.com
name: null
phone: null
tax_exempt: null
tax_ids: null
customer_email: null
expires_at: 1661790807
livemode: false
locale: null
metadata: []
mode: subscription
payment_intent: null
payment_link: null
payment_method_collection: always
payment_method_options: null
payment_method_types:
- card
payment_status: unpaid
phone_number_collection:
enabled: false
recovered_from: null
setup_intent: null
shipping: null
shipping_address_collection: null
shipping_options: []
shipping_rate: null
status: open
submit_type: null
subscription: null
success_url: 'http://192.168.56.56/subscriptions?succeeded=1'
total_details:
amount_discount: 0
amount_shipping: 0
amount_tax: 0
url: 'https://checkout.stripe.com/pay/cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz#fidkdWxOYHwnPyd1blpxYHZxWnM1SFYxSWxob0dxT1ZwZHBKNEwwT3w0QycpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl'
properties:
message:
type: string
example: 'Checkout Done Successfully'
data:
type: object
example:
session:
id: cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz
object: checkout.session
after_expiration: null
allow_promotion_codes: null
amount_subtotal: 250
amount_total: 250
automatic_tax:
enabled: false
status: null
billing_address_collection: null
cancel_url: 'http://192.168.56.56/subscriptions?succeeded=0'
client_reference_id: null
consent: null
consent_collection: null
currency: usd
customer: cus_MIuXULsVAov3Pv
customer_creation: null
customer_details:
address: null
email: kepef@mailinator.com
name: null
phone: null
tax_exempt: null
tax_ids: null
customer_email: null
expires_at: 1661790807
livemode: false
locale: null
metadata: []
mode: subscription
payment_intent: null
payment_link: null
payment_method_collection: always
payment_method_options: null
payment_method_types:
- card
payment_status: unpaid
phone_number_collection:
enabled: false
recovered_from: null
setup_intent: null
shipping: null
shipping_address_collection: null
shipping_options: []
shipping_rate: null
status: open
submit_type: null
subscription: null
success_url: 'http://192.168.56.56/subscriptions?succeeded=1'
total_details:
amount_discount: 0
amount_shipping: 0
amount_tax: 0
url: 'https://checkout.stripe.com/pay/cs_test_a1r56zz93N1OzbcpVUBdN7Cv1bMJmFmzqU4C8Yd5TIpVZJPPn7S5qqXstz#fidkdWxOYHwnPyd1blpxYHZxWnM1SFYxSWxob0dxT1ZwZHBKNEwwT3w0QycpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl'
tags:
- Subscriptions
/api/subscriptions/renew/customer-portal-session:
post:
summary: 'Create Customer Portal Session to renew subscription'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Portal Done Successfully'
data:
session:
id: bps_1MgUlIHlSdZh4mNSw4ghwsEd
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677596800
customer: cus_NMltWmnoFS1rj2
flow:
after_completion:
hosted_confirmation: null
redirect:
return_url: 'https://digitalsero-backend.test/subscriptions'
type: redirect
subscription_cancel:
subscription: sub_1MgUjqHlSdZh4mNSiQIHKfxb
type: subscription_cancel
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUk5XV1FwNmFDMld6TGpXMndGdXBibk5XdERSV2FQ0100cyUik2du/flow'
properties:
message:
type: string
example: 'Portal Done Successfully'
data:
type: object
example:
session:
id: bps_1MgUlIHlSdZh4mNSw4ghwsEd
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677596800
customer: cus_NMltWmnoFS1rj2
flow:
after_completion:
hosted_confirmation: null
redirect:
return_url: 'https://digitalsero-backend.test/subscriptions'
type: redirect
subscription_cancel:
subscription: sub_1MgUjqHlSdZh4mNSiQIHKfxb
type: subscription_cancel
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUk5XV1FwNmFDMld6TGpXMndGdXBibk5XdERSV2FQ0100cyUik2du/flow'
tags:
- Subscriptions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
subscription_id:
type: string
description: ''
example: aut
required:
- subscription_id
/api/subscriptions/update-price:
post:
summary: 'Update subscription price'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Checkout Done Successfully'
data:
session:
id: bps_1MgldOHlSdZh4mNSiP8XGd3x
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677661658
customer: cus_NMn44Vx47uPaeq
flow: null
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUmV4VTNPQk9MUW5sOERmeWdoUm5ZS25WQnVuVHNY0100DR7sNYlu/subscriptions/sub_1Mc3VxHlSdZh4mNSvm8UtsKo/preview/price_1MdaF1HlSdZh4mNSyrCsx8Bw'
properties:
message:
type: string
example: 'Checkout Done Successfully'
data:
type: object
example:
session:
id: bps_1MgldOHlSdZh4mNSiP8XGd3x
object: billing_portal.session
configuration: bpc_1MMVvbHlSdZh4mNSLayW7O22
created: 1677661658
customer: cus_NMn44Vx47uPaeq
flow: null
livemode: false
locale: null
on_behalf_of: null
return_url: 'https://digitalsero-backend.test/subscriptions'
url: 'https://billing.stripe.com/p/session/test_YWNjdF8xOGY5NExIbFNkWmg0bU5TLF9OUmV4VTNPQk9MUW5sOERmeWdoUm5ZS25WQnVuVHNY0100DR7sNYlu/subscriptions/sub_1Mc3VxHlSdZh4mNSvm8UtsKo/preview/price_1MdaF1HlSdZh4mNSyrCsx8Bw'
tags:
- Subscriptions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
price_id:
type: string
description: ''
example: ea
required:
- price_id
/api/admin/users:
get:
summary: 'List Users For Datatable'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 101
name: Alex
email: alex@b5digital.dk
emailVerifiedAt:
date: 22-08-2022
datetime: '22-08-2022 06:47:00 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:47 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 22-08-2022
datetime: '22-08-2022 06:45:12 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:45 PM'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 23-08-2022
datetime: '23-08-2022 09:04:23 AM'
forHumans: '1 second ago'
formatted: 'Tue, Aug 23, 2022 9:04 AM'
userSocialProviders: []
current_subscription:
id: 58
agency_id: 48
plan_id: 1
name: 'Default Plan'
stripe_id: sub_1LZfeNHlSdZh4mNSxCLzBsSd
stripe_status: active
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
trial_ends_at: null
ends_at: null
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
items:
-
id: 9
subscription_id: 58
stripe_id: si_MIGAKvMVEPQffA
stripe_product: prod_MDzJW5t2eL6uJK
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 101
name: Alex
email: alex@b5digital.dk
emailVerifiedAt:
date: 22-08-2022
datetime: '22-08-2022 06:47:00 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:47 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 22-08-2022
datetime: '22-08-2022 06:45:12 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:45 PM'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 23-08-2022
datetime: '23-08-2022 09:04:23 AM'
forHumans: '1 second ago'
formatted: 'Tue, Aug 23, 2022 9:04 AM'
userSocialProviders: []
current_subscription:
id: 58
agency_id: 48
plan_id: 1
name: 'Default Plan'
stripe_id: sub_1LZfeNHlSdZh4mNSxCLzBsSd
stripe_status: active
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
trial_ends_at: null
ends_at: null
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
items:
-
id: 9
subscription_id: 58
stripe_id: si_MIGAKvMVEPQffA
stripe_product: prod_MDzJW5t2eL6uJK
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
tags:
- 'Super Admin'
post:
summary: 'Add User'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- 'Super Admin'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: john
email:
type: string
description: ''
example: john@b5digital.dk
roleId:
type: string
description: ''
example: '"EMPLOYEE"'
required:
- name
- email
- roleId
/api/admin/roles:
get:
summary: 'List All User Roles'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
id: SUPER_ADMIN
name: 'Super Admin'
-
id: SUPER_ADMIN
name: 'Super Admin'
properties:
data:
type: array
example:
-
id: SUPER_ADMIN
name: 'Super Admin'
-
id: SUPER_ADMIN
name: 'Super Admin'
items:
type: object
tags:
- 'Super Admin'
/api/admin/agencies/list:
get:
summary: 'List Agencies For Datatable'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
-
name: 4s8ZVRozDX
updated_at: '25-03-2024 11:19:38'
created_at: '2024-03-25T11:19:38.000000Z'
id: 2639
current_subscription: null
-
name: CMYYxm7svO
updated_at: '25-03-2024 11:19:38'
created_at: '2024-03-25T11:19:38.000000Z'
id: 2640
current_subscription: null
draw: '0'
recordsTotal: '1'
recordsFiltered: '1'
properties:
data:
type: array
example:
-
name: 4s8ZVRozDX
updated_at: '25-03-2024 11:19:38'
created_at: '2024-03-25T11:19:38.000000Z'
id: 2639
current_subscription: null
-
name: CMYYxm7svO
updated_at: '25-03-2024 11:19:38'
created_at: '2024-03-25T11:19:38.000000Z'
id: 2640
current_subscription: null
items:
type: object
draw:
type: string
example: '0'
recordsTotal:
type: string
example: '1'
recordsFiltered:
type: string
example: '1'
tags:
- 'Super Admin'
'/api/admin/users/{user_slug}/active':
post:
summary: 'Activate User'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- 'Super Admin'
parameters:
-
in: path
name: user_slug
description: 'The slug of the user.'
example: admin
required: true
schema:
type: string
'/api/admin/users/{user_slug}/deactivate':
post:
summary: 'DeActivate User'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- 'Super Admin'
parameters:
-
in: path
name: user_slug
description: 'The slug of the user.'
example: admin
required: true
schema:
type: string
/api/social-providers/tiktok/business-centers:
get:
summary: 'List Business Centers'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Business centers listed successfully\"\n \"data\": [\n {\n \"id\": \"12121212121\",\n \"name\": \"Center name\"\n }\n ]\n }"
tags:
- Tiktok
/api/social-providers/tiktok/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNKNOWN
message: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details: []
trace: ''
properties:
type:
type: string
example: UNKNOWN
message:
type: string
example: 'Invalid Host "{agencysubdomain}.digitalsero-staging-api.b5digital.dk".'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Tiktok
/api/demo/social-providers/tiktok/ad-accounts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
type: UNAUTHENTICATED
message: 'Authentication failed. Please check your credentials and try again.'
details: []
trace: ''
properties:
type:
type: string
example: UNAUTHENTICATED
message:
type: string
example: 'Authentication failed. Please check your credentials and try again.'
details:
type: array
example: []
trace:
type: string
example: ''
tags:
- Tiktok
'/api/user-social-providers/{userSocialProvider_id}/default':
post:
summary: 'Set User Social Provider as Default'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"message\": \"Your social Account set to default.\"\n \"data\": []\n }"
tags:
- UserSocialProviders
parameters:
-
in: path
name: userSocialProvider_id
description: 'The ID of the userSocialProvider.'
example: 6
required: true
schema:
type: integer
/api/users/me:
get:
summary: Profile
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Users
put:
summary: 'Update Profile'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: john
email:
type: string
description: ''
example: john@b5digital.dk
required:
- name
- email
/api/users/me/removeProfilePicture:
put:
summary: 'Remove Profile Picture'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Users
/api/users:
get:
summary: 'List Users For Datatable'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 101
name: Alex
email: alex@b5digital.dk
emailVerifiedAt:
date: 22-08-2022
datetime: '22-08-2022 06:47:00 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:47 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 22-08-2022
datetime: '22-08-2022 06:45:12 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:45 PM'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 23-08-2022
datetime: '23-08-2022 09:04:23 AM'
forHumans: '1 second ago'
formatted: 'Tue, Aug 23, 2022 9:04 AM'
userSocialProviders: []
current_subscription:
id: 58
agency_id: 48
plan_id: 1
name: 'Default Plan'
stripe_id: sub_1LZfeNHlSdZh4mNSxCLzBsSd
stripe_status: active
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
trial_ends_at: null
ends_at: null
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
items:
-
id: 9
subscription_id: 58
stripe_id: si_MIGAKvMVEPQffA
stripe_product: prod_MDzJW5t2eL6uJK
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 101
name: Alex
email: alex@b5digital.dk
emailVerifiedAt:
date: 22-08-2022
datetime: '22-08-2022 06:47:00 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:47 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 22-08-2022
datetime: '22-08-2022 06:45:12 PM'
forHumans: '14 hours ago'
formatted: 'Mon, Aug 22, 2022 6:45 PM'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 23-08-2022
datetime: '23-08-2022 09:04:23 AM'
forHumans: '1 second ago'
formatted: 'Tue, Aug 23, 2022 9:04 AM'
userSocialProviders: []
current_subscription:
id: 58
agency_id: 48
plan_id: 1
name: 'Default Plan'
stripe_id: sub_1LZfeNHlSdZh4mNSxCLzBsSd
stripe_status: active
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
trial_ends_at: null
ends_at: null
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
items:
-
id: 9
subscription_id: 58
stripe_id: si_MIGAKvMVEPQffA
stripe_product: prod_MDzJW5t2eL6uJK
stripe_price: price_1LVXL7HlSdZh4mNSOMNmIT8z
quantity: 1
created_at: '2022-08-22T18:47:04.000000Z'
updated_at: '2022-08-22T18:47:04.000000Z'
tags:
- Users
post:
summary: 'Add User'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: multipart/form-data
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Users
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: ''
example: john
email:
type: string
description: ''
example: john@b5digital.dk
roleId:
type: string
description: ''
example: '"EMPLOYEE"'
profilePicture:
type: string
format: binary
description: ''
required:
- name
- email
- roleId
'/api/users/{user_slug}':
get:
summary: 'Show User'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Users
put:
summary: 'Update User'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: john
roleId:
type: string
description: ''
example: '"EMPLOYEE"'
email:
type: string
description: ''
example: john@b5digital.dk
required:
- name
- roleId
- email
delete:
summary: 'Delete User'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"message\": \"User deleted successfully\",\n \"data\": null,\n }\n }"
tags:
- Users
parameters:
-
in: path
name: user_slug
description: 'The slug of the user.'
example: admin
required: true
schema:
type: string
-
in: path
name: slug
description: ''
example: employee-name
required: true
schema:
type: string
'/api/users/set-password/{user_slug}':
post:
summary: 'Set User Password'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User retrieved successfully'
data:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
properties:
message:
type: string
example: 'User retrieved successfully'
data:
type: object
example:
id: 113
name: 'Hadley Rivas'
email: kepef@mailinator.com
emailVerifiedAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:59 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
profilePicture: null
lastActiveAt: null
createdAt:
date: 24-08-2022
datetime: '24-08-2022 12:29:20 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:29 PM'
agency:
id: 101
stripe_id: cus_MIuXULsVAov3Pv
name: null
created_at: '2022-08-24T12:29:20.000000Z'
updated_at: '2022-08-24T12:29:59.000000Z'
roles:
-
id: AGENCY_ADMIN
name: 'Agency admin'
createdAt:
date: 28-08-2022
datetime: '28-08-2022 03:25:51 PM'
forHumans: '1 second ago'
formatted: 'Sun, Aug 28, 2022 3:25 PM'
userSocialProviders: []
current_subscription:
id: 110
name: 'Starter PLAN'
stripe_status: active
quantity: 1
trial_ends_at: null
plan:
id: 3
stripe_id: starter
name: 'Starter PLAN'
active: 1
interval: month
is_default: false
features: false
providers:
-
id: 7
plan_id: 3
provider_id: META
limit: 15
-
id: 8
plan_id: 3
provider_id: GOOGLE
limit: 10
price:
id: 3
stripe_id: starter
amount: 3.59
billing_scheme: per_unit
currency: usd
interval: null
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
created_at:
date: 16-08-2022
datetime: '16-08-2022 11:52:41 AM'
forHumans: '1 week ago'
formatted: 'Tue, Aug 16, 2022 11:52 AM'
ends_at:
date: 24-09-2022
datetime: '24-09-2022 12:52:16 PM'
forHumans: '3 weeks from now'
formatted: 'Sat, Sep 24, 2022 12:52 PM'
created_at:
date: 24-08-2022
datetime: '24-08-2022 12:30:01 PM'
forHumans: '4 days ago'
formatted: 'Wed, Aug 24, 2022 12:30 PM'
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: password
email:
type: string
description: ''
example: john@b5digital.dk
password_confirmation:
type: string
description: ''
example: password
token:
type: string
description: ''
example: asd12rmfahf23
required:
- password
- email
- password_confirmation
- token
parameters:
-
in: path
name: user_slug
description: 'The slug of the user.'
example: admin
required: true
schema:
type: string
/api/users/me/onboarding/video-watch:
post:
summary: ''
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Users
tags:
-
name: AccessRequests
description: ''
-
name: Agencies
description: ''
-
name: Auth
description: ''
-
name: DemoAccessRequests
description: ''
-
name: Endpoints
description: ''
-
name: Google
description: ''
-
name: Insights
description: ''
-
name: Invoices
description: ''
-
name: LinkedIn
description: ''
-
name: Meta
description: ''
-
name: PaymentMethods
description: ''
-
name: Prices
description: ''
-
name: Products
description: ''
-
name: Promotions
description: ''
-
name: 'Roles & Permissions'
description: ''
-
name: SocialProviders
description: ''
-
name: Subscriptions
description: ''
-
name: 'Super Admin'
description: ''
-
name: Tiktok
description: ''
-
name: UserSocialProviders
description: ''
-
name: Users
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: ''
security:
-
default: []