Kota providers API
The providers API from Kota — 2 operation(s) for providers.
OpenAPI Specification
openapi: 3.1.0
info:
title: API Reference Associated Persons providers API
version: 1.0.0
servers:
- url: https://test.api.kota.io
description: test
- url: https://api.kota.io
description: production
tags:
- name: providers
paths:
/providers:
get:
operationId: list-providers
summary: List all providers
description: Returns a list of `providers`.
tags:
- providers
parameters:
- name: country
in: query
description: Filter by country; only providers that support this country are returned.
required: false
schema:
$ref: '#/components/schemas/CountryCodeEnumParameter'
- name: page
in: query
description: The page of results to return. Defaults to 1 if not provided.
required: false
schema:
type: integer
- name: page_size
in: query
description: The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.
required: false
schema:
type: integer
- name: Authorization
in: header
description: Authorization header using the Bearer scheme
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderResponsePagedList'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HttpValidationProblemDetails'
/providers/{provider_id}:
get:
operationId: retrieve-provider
summary: Retrieve a provider
description: Retrieves a `provider` object by its ID.
tags:
- providers
parameters:
- name: provider_id
in: path
required: true
schema:
type: string
- name: Authorization
in: header
description: Authorization header using the Bearer scheme
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
components:
schemas:
CountryCode:
type: string
enum:
- af
- ax
- al
- dz
- as
- ad
- ao
- ai
- aq
- ag
- ar
- am
- aw
- au
- at
- az
- bs
- bh
- bd
- bb
- by
- be
- bz
- bj
- bm
- bt
- bo
- bq
- ba
- bw
- bv
- br
- io
- bn
- bg
- bf
- bi
- cv
- kh
- cm
- ca
- ky
- cf
- td
- cl
- cn
- cx
- cc
- co
- km
- cg
- cd
- ck
- cr
- ci
- hr
- cu
- cw
- cy
- cz
- dk
- dj
- dm
- do
- ec
- eg
- sv
- gq
- er
- ee
- sz
- et
- fk
- fo
- fj
- fi
- fr
- gf
- pf
- tf
- ga
- gm
- ge
- de
- gh
- gi
- gr
- gl
- gd
- gp
- gu
- gt
- gg
- gn
- gw
- gy
- ht
- hm
- va
- hn
- hk
- hu
- is
- in
- id
- ir
- iq
- ie
- im
- il
- it
- jm
- jp
- je
- jo
- kz
- ke
- ki
- kp
- kr
- xk
- kw
- kg
- la
- lv
- lb
- ls
- lr
- ly
- li
- lt
- lu
- mo
- mg
- mw
- my
- mv
- ml
- mt
- mh
- mq
- mr
- mu
- yt
- mx
- fm
- md
- mc
- mn
- me
- ms
- ma
- mz
- mm
- na
- nr
- np
- nl
- nc
- nz
- ni
- ne
- ng
- nu
- nf
- mk
- mp
- 'no'
- om
- pk
- pw
- ps
- pa
- pg
- py
- pe
- ph
- pn
- pl
- pt
- pr
- qa
- re
- ro
- ru
- rw
- bl
- sh
- kn
- lc
- mf
- pm
- vc
- ws
- sm
- st
- sa
- sn
- rs
- sc
- sl
- sg
- sx
- sk
- si
- sb
- so
- za
- gs
- ss
- es
- lk
- sd
- sr
- sj
- se
- ch
- sy
- tw
- tj
- tz
- th
- tl
- tg
- tk
- to
- tt
- tn
- tr
- tm
- tc
- tv
- ug
- ua
- ae
- gb
- um
- us
- uy
- uz
- vu
- ve
- vn
- vg
- vi
- wf
- eh
- ye
- zm
- zw
title: CountryCode
CountryCodeEnumParameter:
type: object
properties:
value:
$ref: '#/components/schemas/CountryCode'
title: CountryCodeEnumParameter
HttpValidationProblemDetails:
type: object
properties:
type:
type:
- string
- 'null'
title:
type:
- string
- 'null'
status:
type:
- integer
- 'null'
detail:
type:
- string
- 'null'
instance:
type:
- string
- 'null'
errors:
type: object
additionalProperties:
type: array
items:
type: string
title: HttpValidationProblemDetails
ProblemDetails:
type: object
properties:
type:
type:
- string
- 'null'
title:
type:
- string
- 'null'
status:
type:
- integer
- 'null'
detail:
type:
- string
- 'null'
instance:
type:
- string
- 'null'
title: ProblemDetails
ProviderResponse:
type: object
properties:
object:
type: string
description: Object type. Always `provider`.
id:
type: string
description: Unique identifier for the provider. Prefixed with `pr_`.
name:
type: string
description: The name of the provider.
description:
type: string
description: Description of the provider.
website_url:
type: string
description: The provider's main website URL.
logo_url:
type: string
description: URL to the provider's logo image.
employer_platform_url:
type:
- string
- 'null'
description: URL to the employer portal/platform for this provider, if available.
kota_hub_url:
type:
- string
- 'null'
description: URL to the Kota Hub page for this platform, if configured.
support_phone:
type: string
description: Customer support phone number.
supported_countries:
type: array
items:
$ref: '#/components/schemas/CountryCode'
description: List of countries supported by this provider.
required:
- id
- name
- description
- website_url
- logo_url
- support_phone
- supported_countries
title: ProviderResponse
ProviderResponsePagedList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ProviderResponse'
description: A paginated array containing the response elements
page:
type: integer
description: The current page of the results
page_size:
type: integer
description: The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size
total_count:
type: integer
description: The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.
has_next_page:
type: boolean
description: Whether there are more pages available after this page
has_previous_page:
type: boolean
description: Whether there are more pages available before this page
required:
- items
- page
- page_size
- total_count
title: ProviderResponsePagedList
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Authorization header using the Bearer scheme