Popsink public api
Welcome to Popsink, your go-to SaaS solution for seamless programmatic interaction! With our API service, developers can effortlessly integrate Popsink's powerful features into their applications and workflows. Whether it's automating tasks, accessing data, or managing resources, our API provides a flexible and intuitive interface to unleash the full potential of Popsink. Experience the convenience and efficiency of programmatically interacting with Popsink to streamline your processes and unlock new possibilities.
organizations
GET /organizations/
Get Organizations
Description
Get the organizations of the current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
authorization |
header | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
}
POST /organizations/
Create Organization
Description
Create an organization.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
authorization |
header | string | No |
Request body
{
"name": "string",
"region_label": "string"
}
Schema of the request body
{
"title": "OrganizationConfig",
"required": [
"name",
"region_label"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"region_label": {
"title": "Region Label",
"type": "string"
}
},
"description": "Define a message event, to send to Kafka."
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
}
GET /organizations/{organization_uuid}/
Get Organization
Description
Get a specific organization details.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
authorization |
header | string | No | ||
organization_uuid |
path | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
}
DELETE /organizations/{organization_uuid}/
Delete Organization
Description
Delete a specific organization.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
authorization |
header | string | No | ||
organization_uuid |
path | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
}
Endpoints
GET /users/me/
Get Me
Description
Get the current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
authorization |
header | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
}
GET /
Root
Description
Root message.
Response 200 OK
Schema of the response body
POST /auth/
Auth
Description
Authenticate the user from Auth0.
Auth0 response is like: { "access_token": "eyJ...Ggg", "expires_in": 86400, "scope": "read:clients create:clients read:client_keys", "token_type": "Bearer" }
Request body
{
"username": "string",
"password": "string"
}
Schema of the request body
{
"title": "Credentials",
"required": [
"username",
"password"
],
"type": "object",
"properties": {
"username": {
"title": "Username",
"type": "string"
},
"password": {
"title": "Password",
"type": "string"
}
},
"description": "Define a message event, to send to kafka."
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
}
Schemas
Credentials
| Name | Type |
|---|---|
password |
string |
username |
string |
HTTPValidationError
| Name | Type |
|---|---|
detail |
Array<ValidationError> |
OrganizationConfig
| Name | Type |
|---|---|
name |
string |
region_label |
string |
ValidationError
| Name | Type |
|---|---|
loc |
Array<> |
msg |
string |
type |
string |