MENU navbar-image

Introduction

You can use our ProductLift's API to smoothly integrate ProductLift with other services.

This documentation aims to provide all the information you need to work with our API.

Base URL

{YOUR_PORTAL_URL}

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your portal and go to Customize > API & Webhooks.

Anonymous Votes

Manage anonymous votes on posts and comments.

Vote anonymously

requires authentication

Add an anonymous vote to a post or comment.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/labore" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/labore"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/labore',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/labore'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "created_at": "2024-11-08T15:15:01.000000Z",
        "voter": null
    }
}

Example response (404):


{
    "message": "No query results for model ..."
}

Example response (422):


{
    "message": "Item is not voteable."
}

Example response (422):


{
    "message": "Anonymous user has already voted for this item."
}

Request   

POST api/v1/posts/{key}/anonymous_votes/{anonymous_id}

URL Parameters

key  string  

The ID of the post or comment.

anonymous_id  string  

The ID of the anonymous.

anonymousId  string  

The MD5 hash representing the anonymous user.

Revoke anonymous vote

requires authentication

Revoke an anonymous vote for a post or comment.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/ea" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/ea"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/ea',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/anonymous_votes/ea'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model ..."
}

Example response (422):


{
    "message": "Item is not voteable."
}

Example response (422):


{
    "message": "Anonymous user has not voted yet."
}

Request   

DELETE api/v1/posts/{key}/anonymous_votes/{anonymous_id}

URL Parameters

key  string  

The ID of the post or comment.

anonymous_id  string  

The ID of the anonymous.

anonymousId  string  

The MD5 hash representing the anonymous user.

Categories

Categories (e.g. Bug, Integration) can be used to organize and group posts. Categories are visible for your users. Posts can have multiple categories.

List categories

requires authentication

Lists all categories of your portal.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/categories',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/categories'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "name": "Bug",
            "color": "#ABDEE6"
        },
        {
            "id": 1,
            "name": "Bug",
            "color": "#ABDEE6"
        }
    ]
}

Request   

GET api/v1/categories

Create category

requires authentication

Creates a new category in your portal.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/categories',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/categories'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "Bug",
        "color": "#ABDEE6"
    }
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "name": [
     "The name has already been taken."
 ]
}

Request   

POST api/v1/categories

Body Parameters

name  string optional  

Delete category

requires authentication

Deletes a specified category.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/categories/10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/categories/10"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/categories/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/categories/10'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "message": "Category deleted successfully"
}

Example response (404):


{
    "message": "Category not found"
}

Example response (403):


{
    "message": "You do not have permission to delete this category"
}

Request   

DELETE api/v1/categories/{id}

URL Parameters

id  integer  

The ID of the category.

Update category

requires authentication

Updates the details of a category.

Example request:
curl --request PATCH \
    "{YOUR_PORTAL_URL}/api/v1/categories/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"cxpufvyaeptbbppdwsfc\",
    \"color\": \"#85E441$\\/m\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/categories/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "cxpufvyaeptbbppdwsfc",
    "color": "#85E441$\/m"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    '{YOUR_PORTAL_URL}/api/v1/categories/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'cxpufvyaeptbbppdwsfc',
            'color' => '#85E441$/m',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/categories/2'
payload = {
    "name": "cxpufvyaeptbbppdwsfc",
    "color": "#85E441$\/m"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "Bug",
        "color": "#ABDEE6"
    }
}

Example response (404):


{
    "message": "Category not found."
}

Example response (403):


{
    "message": "You do not have permission to update this category."
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name has already been taken.",
            "The name must be at least 2 characters.",
            "The name may not be greater than 60 characters."
        ],
        "color": [
            "The color format is invalid. It should be a valid hex color code (e.g., #FF5733)."
        ]
    }
}

Request   

PATCH api/v1/categories/{id}

URL Parameters

id  integer  

The ID of the category.

Body Parameters

name  string  

Name of the category. Must be at least 2 characters. Must not be greater than 60 characters.

color  string  

Hex color code for the category. The value format is invalid.

Comments

Comments can be added to posts. Each post can have multiple comments.

List comments

requires authentication

Retrieves all comments for a specific post.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": null,
            "comment": "Yes 😍",
            "author": {
                "id": "235b116c-12fc-415b-9e85-bbf6e176bec4",
                "name": "Bruce Wayne",
                "email": "idibaliban@gmail.com",
                "role": "member",
                "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
                "avatar_small_url": "https://www.gravatar.com/avatar/267797e7f01a10c3119ccccddef73613?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Bruce+Wayne/60/FFC8A2/69320c",
                "counter_votes": 0,
                "counter_comments": 0,
                "counter_posts": 0,
                "counter_comment_votes": 0,
                "created_at": "2024-04-26T19:18:20.000000Z",
                "is_blocked": 0,
                "verified": false,
                "admin_accepted": 1,
                "sso_uid": null,
                "sso_avatar_url": null,
                "company": null,
                "segment_1": null,
                "segment_2": null,
                "segment_3": null,
                "segment_4": null,
                "segment_5": null,
                "segment_6": null,
                "segment_7": null,
                "segment_8": null,
                "segment_9": null,
                "segment_10": null,
                "segment_mrr": null,
                "segment_arr": null,
                "segment_ltv": null,
                "email_unsubscribed_at": null
            },
            "pinned_to_top": false,
            "tagged_for_changelog": false,
            "parent_id": null,
            "created_at": null,
            "updated_at": null,
            "url": "{YOUR-PORTAL-URL}/p/example-slug-123456#comment_123"
        },
        {
            "id": null,
            "comment": "Yes 😍",
            "author": {
                "id": "cb96fbf0-e44e-4879-9d11-b3f6564b8029",
                "name": "Bruce Wayne",
                "email": "brandondesousa9@gmail.com",
                "role": "member",
                "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
                "avatar_small_url": "https://www.gravatar.com/avatar/c32092ade1fa29ce49f9bd771c85afa6?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Bruce+Wayne/60/FFC8A2/69320c",
                "counter_votes": 0,
                "counter_comments": 0,
                "counter_posts": 0,
                "counter_comment_votes": 0,
                "created_at": "2024-04-19T20:30:18.000000Z",
                "is_blocked": 0,
                "verified": false,
                "admin_accepted": 1,
                "sso_uid": null,
                "sso_avatar_url": null,
                "company": null,
                "segment_1": null,
                "segment_2": null,
                "segment_3": null,
                "segment_4": null,
                "segment_5": null,
                "segment_6": null,
                "segment_7": null,
                "segment_8": null,
                "segment_9": null,
                "segment_10": null,
                "segment_mrr": null,
                "segment_arr": null,
                "segment_ltv": null,
                "email_unsubscribed_at": null
            },
            "pinned_to_top": false,
            "tagged_for_changelog": false,
            "parent_id": null,
            "created_at": null,
            "updated_at": null,
            "url": "{YOUR-PORTAL-URL}/p/example-slug-123456#comment_123"
        }
    ]
}

Example response (404):


{
    "message": "No query results for model [App\\Post] ..."
}

Request   

GET api/v1/posts/{postId}/comments

URL Parameters

postId  string  

The unique key of the post.

Create comment

requires authentication

Adds a new comment to a specific post.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"b4213b16-3d0f-300d-89a5-4ad59a5635d7\",
    \"comment\": \"This is a new comment\",
    \"parent_id\": 1,
    \"tagged_for_changelog\": \"1\",
    \"pinned_to_top\": \"true\",
    \"created_at\": \"2023-08-11 14:30:00\",
    \"use_for_changelog\": false,
    \"pin_to_top\": false
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "b4213b16-3d0f-300d-89a5-4ad59a5635d7",
    "comment": "This is a new comment",
    "parent_id": 1,
    "tagged_for_changelog": "1",
    "pinned_to_top": "true",
    "created_at": "2023-08-11 14:30:00",
    "use_for_changelog": false,
    "pin_to_top": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 'b4213b16-3d0f-300d-89a5-4ad59a5635d7',
            'comment' => 'This is a new comment',
            'parent_id' => 1,
            'tagged_for_changelog' => '1',
            'pinned_to_top' => 'true',
            'created_at' => '2023-08-11 14:30:00',
            'use_for_changelog' => false,
            'pin_to_top' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/abc123/comments'
payload = {
    "user_id": "b4213b16-3d0f-300d-89a5-4ad59a5635d7",
    "comment": "This is a new comment",
    "parent_id": 1,
    "tagged_for_changelog": "1",
    "pinned_to_top": "true",
    "created_at": "2023-08-11 14:30:00",
    "use_for_changelog": false,
    "pin_to_top": false
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": null,
        "comment": "This is amazing. I would like to have this.",
        "author": {
            "id": "d50ce8dd-ca97-4676-9c2b-220d90814732",
            "name": "Bruce MacLeod",
            "email": "macleod@maine.edu",
            "role": "member",
            "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
            "avatar_small_url": "https://www.gravatar.com/avatar/f954a3dcab56c7755cb28c1f7063f954?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Bruce+MacLeod/60/FFAEA5/69180f",
            "counter_votes": 0,
            "counter_comments": 1,
            "counter_posts": 0,
            "counter_comment_votes": 0,
            "created_at": "2024-08-08T13:11:01.000000Z",
            "is_blocked": 0,
            "verified": false,
            "admin_accepted": 1,
            "sso_uid": null,
            "sso_avatar_url": null,
            "company": null,
            "segment_1": null,
            "segment_2": null,
            "segment_3": null,
            "segment_4": null,
            "segment_5": null,
            "segment_6": null,
            "segment_7": null,
            "segment_8": null,
            "segment_9": null,
            "segment_10": null,
            "segment_mrr": null,
            "segment_arr": null,
            "segment_ltv": null,
            "email_unsubscribed_at": null
        },
        "pinned_to_top": false,
        "tagged_for_changelog": false,
        "parent_id": null,
        "created_at": null,
        "updated_at": null,
        "url": "{YOUR-PORTAL-URL}/p/example-slug-123456#comment_123"
    }
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "comment": [
            "The comment field is required."
        ]
    }
}

Request   

POST api/v1/posts/{postId}/comments

URL Parameters

postId  string  

The unique key of the post.

Body Parameters

user_id  string  

Must be a valid UUID.

comment  string  

The content of the comment.

parent_id  integer optional  

nullable The ID of the parent comment if this is a reply.

tagged_for_changelog  string optional  

Must be one of true, false, 0, or 1.

pinned_to_top  string optional  

Must be one of true, false, 0, or 1.

created_at  string optional  

nullable The creation timestamp of the comment.

use_for_changelog  boolean optional  

nullable Whether to tag this comment for changelog.

pin_to_top  boolean optional  

nullable Whether to pin this comment to the top.

Update comment

requires authentication

Updates the details of a comment.

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/comments/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"comment\": \"This is an updated comment\",
    \"parent_id\": 1,
    \"tagged_for_changelog\": \"0\",
    \"pinned_to_top\": \"1\",
    \"created_at\": \"2023-08-11 14:30:00\",
    \"use_for_changelog\": false,
    \"pin_to_top\": false
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/comments/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "comment": "This is an updated comment",
    "parent_id": 1,
    "tagged_for_changelog": "0",
    "pinned_to_top": "1",
    "created_at": "2023-08-11 14:30:00",
    "use_for_changelog": false,
    "pin_to_top": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/comments/6',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'comment' => 'This is an updated comment',
            'parent_id' => 1,
            'tagged_for_changelog' => '0',
            'pinned_to_top' => '1',
            'created_at' => '2023-08-11 14:30:00',
            'use_for_changelog' => false,
            'pin_to_top' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/comments/6'
payload = {
    "comment": "This is an updated comment",
    "parent_id": 1,
    "tagged_for_changelog": "0",
    "pinned_to_top": "1",
    "created_at": "2023-08-11 14:30:00",
    "use_for_changelog": false,
    "pin_to_top": false
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": null,
        "comment": "This is a must-have!",
        "author": {
            "id": "191dc920-ea5e-4588-bd8e-4ced481839b8",
            "name": "Gediminas",
            "email": "gediminas@reikiait.lt",
            "role": "member",
            "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
            "avatar_small_url": "https://www.gravatar.com/avatar/87b49b5a08ca509e20ebb1db70f1209e?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Gediminas/60/FFC5BF/692f29",
            "counter_votes": 0,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0,
            "created_at": "2024-08-05T20:19:58.000000Z",
            "is_blocked": 0,
            "verified": true,
            "admin_accepted": 1,
            "sso_uid": null,
            "sso_avatar_url": null,
            "company": null,
            "segment_1": "Trial",
            "segment_2": null,
            "segment_3": null,
            "segment_4": null,
            "segment_5": null,
            "segment_6": null,
            "segment_7": null,
            "segment_8": null,
            "segment_9": null,
            "segment_10": null,
            "segment_mrr": null,
            "segment_arr": null,
            "segment_ltv": "0.00",
            "email_unsubscribed_at": null
        },
        "pinned_to_top": false,
        "tagged_for_changelog": false,
        "parent_id": null,
        "created_at": null,
        "updated_at": null,
        "url": "{YOUR-PORTAL-URL}/p/example-slug-123456#comment_123"
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Comment] ..."
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "comment": [
            "The comment field is required."
        ]
    }
}

Request   

PUT api/v1/comments/{id}

URL Parameters

id  integer  

The ID of the comment.

Body Parameters

comment  string  

The content of the comment.

parent_id  integer optional  

nullable The ID of the parent comment if this is a reply.

tagged_for_changelog  string optional  

Must be one of true, false, 0, or 1.

pinned_to_top  string optional  

Must be one of true, false, 0, or 1.

created_at  string optional  

nullable The creation timestamp of the comment.

use_for_changelog  boolean optional  

nullable Whether to tag this comment for changelog.

pin_to_top  boolean optional  

nullable Whether to pin this comment to the top.

Delete comment

requires authentication

Deletes a specified comment.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/comments/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/comments/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/comments/6',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/comments/6'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\Comment] ..."
}

Request   

DELETE api/v1/comments/{id}

URL Parameters

id  integer  

The ID of the comment.

Feedback

Handles operations related to user feedback including listing, creating, updating, deleting, and analyzing feedback.

List feedback

requires authentication

Retrieves a collection of all feedback entries, ordered by creation date in descending order.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/feedback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/feedback"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/feedback',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/feedback'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/v1/feedback

Create feedback

requires authentication

Stores a new feedback entry in the database.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/feedback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"fuga\",
    \"feedback\": \"ratione\",
    \"user_id\": \"2ef16b98-f3ad-3046-9d0d-1eee385f06e0\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/feedback"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "fuga",
    "feedback": "ratione",
    "user_id": "2ef16b98-f3ad-3046-9d0d-1eee385f06e0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/feedback',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'fuga',
            'feedback' => 'ratione',
            'user_id' => '2ef16b98-f3ad-3046-9d0d-1eee385f06e0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/feedback'
payload = {
    "type": "fuga",
    "feedback": "ratione",
    "user_id": "2ef16b98-f3ad-3046-9d0d-1eee385f06e0"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "feedback": [
            "The feedback field is required."
        ]
    }
}

Request   

POST api/v1/feedback

Body Parameters

type  string  

feedback  string  

user_id  string optional  

Optional user ID. If not given or not found, the post will be created from the logged in user or anonymous. Must be a valid UUID.

Update feedback

requires authentication

Updates an existing feedback entry.

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/feedback/quibusdam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"feedback\": \"ut\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/feedback/quibusdam"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "feedback": "ut"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/feedback/quibusdam',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'feedback' => 'ut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/feedback/quibusdam'
payload = {
    "feedback": "ut"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (404):


{
    "message": "No query results for model [App\\Models\\Feedback] ..."
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "feedback": [
            "The feedback field must be given."
        ]
    }
}

Request   

PUT api/v1/feedback/{id}

URL Parameters

id  string  

The ID of the feedback.

Body Parameters

feedback  string  

Delete feedback

requires authentication

Removes a specified feedback entry from the database.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/feedback/quis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/feedback/quis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/feedback/quis',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/feedback/quis'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\Models\\Feedback] ..."
}

Request   

DELETE api/v1/feedback/{id}

URL Parameters

id  string  

The ID of the feedback.

Summarize feedback

requires authentication

Generates a summary of filtered feedback using AI analysis.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/feedback/summarize" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"sentiment\": \"neutral\",
    \"focus\": \"value\",
    \"source\": \"fugiat\",
    \"widget\": \"f6926c62-1a9d-3336-946a-c3ac864a2d0e\",
    \"created_from\": \"2024-11-20T10:19:47\",
    \"created_to\": \"2024-11-20T10:19:47\",
    \"keyword\": \"et\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/feedback/summarize"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "sentiment": "neutral",
    "focus": "value",
    "source": "fugiat",
    "widget": "f6926c62-1a9d-3336-946a-c3ac864a2d0e",
    "created_from": "2024-11-20T10:19:47",
    "created_to": "2024-11-20T10:19:47",
    "keyword": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/feedback/summarize',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'sentiment' => 'neutral',
            'focus' => 'value',
            'source' => 'fugiat',
            'widget' => 'f6926c62-1a9d-3336-946a-c3ac864a2d0e',
            'created_from' => '2024-11-20T10:19:47',
            'created_to' => '2024-11-20T10:19:47',
            'keyword' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/feedback/summarize'
payload = {
    "sentiment": "neutral",
    "focus": "value",
    "source": "fugiat",
    "widget": "f6926c62-1a9d-3336-946a-c3ac864a2d0e",
    "created_from": "2024-11-20T10:19:47",
    "created_to": "2024-11-20T10:19:47",
    "keyword": "et"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST api/v1/feedback/summarize

Body Parameters

sentiment  string optional  

Must be one of positive, neutral, or negative.

focus  string optional  

Must be one of usability, functionality, or value.

source  string optional  

widget  string optional  

Must be a valid UUID.

created_from  string optional  

Must be a valid date.

created_to  string optional  

Must be a valid date.

keyword  string optional  

Groups

Group management lets you organize users, control access, and customize experiences. Use it for focus groups, beta tests, customer segments, or team organization. After creating groups, you can set tab visibility for specific groups and choose who can access them.

List groups

requires authentication

Lists all groups.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": "024fbe81-0c1c-4b7e-81d2-d89659c9d6b1",
            "portal_id": 3674,
            "name": "Sureders",
            "description": null,
            "created_at": "2024-10-21T17:15:47.000000Z",
            "updated_at": "2024-10-21T17:15:47.000000Z"
        },
        {
            "id": "024fbe81-0c1c-4b7e-81d2-d89659c9d6b1",
            "portal_id": 3674,
            "name": "Sureders",
            "description": null,
            "created_at": "2024-10-21T17:15:47.000000Z",
            "updated_at": "2024-10-21T17:15:47.000000Z"
        }
    ]
}

Request   

GET api/v1/groups

Create group

requires authentication

Creates a new group.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"pariatur\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "pariatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'description' => 'pariatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups'
payload = {
    "description": "pariatur"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": "024fbe81-0c1c-4b7e-81d2-d89659c9d6b1",
        "portal_id": 3674,
        "name": "Sureders",
        "description": null,
        "created_at": "2024-10-21T17:15:47.000000Z",
        "updated_at": "2024-10-21T17:15:47.000000Z"
    }
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name has already been taken."
        ]
    }
}

Request   

POST api/v1/groups

Body Parameters

name  string optional  

description  string optional  

Show group

requires authentication

Displays details of a specific group.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/groups/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups/11"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/groups/11',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups/11'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": "024fbe81-0c1c-4b7e-81d2-d89659c9d6b1",
        "portal_id": 3674,
        "name": "Sureders",
        "description": null,
        "created_at": "2024-10-21T17:15:47.000000Z",
        "updated_at": "2024-10-21T17:15:47.000000Z"
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Group] ..."
}

Request   

GET api/v1/groups/{id}

URL Parameters

id  integer  

The ID of the group.

Update group

requires authentication

Updates the details of a group.

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/groups/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"fuga\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "fuga"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/groups/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'description' => 'fuga',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups/2'
payload = {
    "description": "fuga"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": "024fbe81-0c1c-4b7e-81d2-d89659c9d6b1",
        "portal_id": 3674,
        "name": "Sureders",
        "description": null,
        "created_at": "2024-10-21T17:15:47.000000Z",
        "updated_at": "2024-10-21T17:15:47.000000Z"
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Group] ..."
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name has already been taken."
        ]
    }
}

Request   

PUT api/v1/groups/{id}

PATCH api/v1/groups/{id}

URL Parameters

id  integer  

The ID of the group.

Body Parameters

name  string optional  

description  string optional  

Delete group

requires authentication

Deletes a specified group.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/groups/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/groups/12',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups/12'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "message": "Group deleted successfully"
}

Example response (404):


{
    "message": "No query results for model [App\\Group] ..."
}

Request   

DELETE api/v1/groups/{id}

URL Parameters

id  integer  

The ID of the group.

Add user to group

requires authentication

Adds a user to the specified group.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/groups/rerum/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 17
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups/rerum/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/groups/rerum/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 17,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups/rerum/users'
payload = {
    "user_id": 17
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "message": "User added to group successfully"
}

Example response (404):


{
    "message": "Group or User not found"
}

Example response (422):


{
    "message": "User is already in the group"
}

Request   

POST api/v1/groups/{group}/users

URL Parameters

group  string  

id  integer  

The ID of the group.

Body Parameters

user_id  integer  

The ID of the user to add.

Remove user from group

requires authentication

Removes a user from the specified group.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/groups/omnis/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 18
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups/omnis/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 18
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/groups/omnis/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 18,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups/omnis/users'
payload = {
    "user_id": 18
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "message": "User removed from group successfully"
}

Example response (404):


{
    "message": "Group or User not found"
}

Example response (422):


{
    "message": "User is not in the group"
}

Request   

DELETE api/v1/groups/{group}/users

URL Parameters

group  string  

id  integer  

The ID of the group.

Body Parameters

user_id  integer  

The ID of the user to remove.

Get users in group

requires authentication

Retrieves all users belonging to a specific group.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/groups/vitae/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/groups/vitae/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/groups/vitae/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/groups/vitae/users'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": "6fc17036-1de0-48ae-b7e0-1398498cebaf",
            "name": "Milo",
            "email": "nienow.myron@example.org",
            "role": "member",
            "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
            "avatar_small_url": "https://www.gravatar.com/avatar/7b680eaebb8ce2be32236d9795fabf61?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Milo/60/55CBCD/003537",
            "counter_votes": 0,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0,
            "created_at": "2024-11-20T10:19:47.000000Z",
            "is_blocked": null,
            "verified": null,
            "admin_accepted": null,
            "sso_uid": null,
            "sso_avatar_url": null,
            "company": null,
            "segment_1": null,
            "segment_2": null,
            "segment_3": null,
            "segment_4": null,
            "segment_5": null,
            "segment_6": null,
            "segment_7": null,
            "segment_8": null,
            "segment_9": null,
            "segment_10": null,
            "segment_mrr": null,
            "segment_arr": null,
            "segment_ltv": null,
            "email_unsubscribed_at": null
        },
        {
            "id": "248d662b-e54d-4406-9092-29a1af97ad4d",
            "name": "Matilda",
            "email": "amos62@example.org",
            "role": "member",
            "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
            "avatar_small_url": "https://www.gravatar.com/avatar/102557f8757be1568bd39ca06b4e3865?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Matilda/60/55CBCD/003537",
            "counter_votes": 0,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0,
            "created_at": "2024-11-20T10:19:47.000000Z",
            "is_blocked": null,
            "verified": null,
            "admin_accepted": null,
            "sso_uid": null,
            "sso_avatar_url": null,
            "company": null,
            "segment_1": null,
            "segment_2": null,
            "segment_3": null,
            "segment_4": null,
            "segment_5": null,
            "segment_6": null,
            "segment_7": null,
            "segment_8": null,
            "segment_9": null,
            "segment_10": null,
            "segment_mrr": null,
            "segment_arr": null,
            "segment_ltv": null,
            "email_unsubscribed_at": null
        }
    ]
}

Example response (200):


{
  "data": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com",
      // ... other user attributes
    },
    // ... more users
  ]
}

Example response (404):


{
    "message": "No query results for model [App\\Group] ..."
}

Request   

GET api/v1/groups/{group}/users

URL Parameters

group  string  

id  integer  

The ID of the group.

Moderation

Handles operations related to post and comment moderation including listing pending and rejected items, approving, and rejecting them.

Get pending items

requires authentication

Retrieves all posts and comments with a moderation status of 'pending'.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/moderation/pending" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/moderation/pending"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/moderation/pending',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/moderation/pending'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/v1/moderation/pending

Get rejected items

requires authentication

Retrieves all posts and comments with a moderation status of 'rejected'.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/moderation/rejected" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/moderation/rejected"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/moderation/rejected',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/moderation/rejected'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/v1/moderation/rejected

Reject item (post or comment)

requires authentication

Updates the specified post or comment's moderation status to 'rejected'.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/moderation/reject/aliquid/magni" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/moderation/reject/aliquid/magni"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/moderation/reject/aliquid/magni',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/moderation/reject/aliquid/magni'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST api/v1/moderation/reject/{type}/{identifier}

URL Parameters

type  string  

identifier  string  

Approve item (post or comment)

requires authentication

Updates the specified post or comment's moderation status to 'approved'.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/moderation/approve/et/labore" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/moderation/approve/et/labore"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/moderation/approve/et/labore',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/moderation/approve/et/labore'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST api/v1/moderation/approve/{type}/{identifier}

URL Parameters

type  string  

identifier  string  

Other endpoints

PUT api/v1/posts/{key}/toggle-publish

requires authentication

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/posts/6/toggle-publish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/6/toggle-publish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/posts/6/toggle-publish',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/6/toggle-publish'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT api/v1/posts/{key}/toggle-publish

URL Parameters

key  integer  

Portal

You should see a portal as a single project for your product or service. It can consist of roadmaps, changelogs, voting boards, etc.

Get portal

requires authentication

Retrieves the details of your portal.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/portal" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/portal"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/portal',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/portal'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "guid": "1d92fb85-dacb-400d-859c-3be9b97b6daa",
        "title": "rerum corrupti",
        "localization": "en"
    }
}

Request   

GET api/v1/portal

Posts

Manage posts.

Find duplicates

requires authentication

Searches the database for duplicate posts.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/posts/search_duplicates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/search_duplicates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/posts/search_duplicates',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/search_duplicates'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
 "count": 0,
}

Example response (200):


{
 "count": 1,
 "posts": {
             {
                 "id": "d8QEXH",
                 "title": "Open links in new window",
                 "description": "Option to open links in a new window."
              }
          }
}

Request   

GET api/v1/posts/search_duplicates

Create post

requires authentication

Creates a new post in your portal.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/posts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=vylrdwkunllvi" \
    --form "description=quas" \
    --form "category_id=15" \
    --form "status_id=14" \
    --form "section_id=12" \
    --form "user_id=a85c05e3-2384-395e-b172-ae4d8d02c821" \
    --form "allow_comments=true" \
    --form "jira_key=numquam" \
    --form "azure_boards_key=voluptas" \
    --form "estimated_date=2024-11-20T10:19:46" \
    --form "tags[]=qlryzqumzhmvlujxivejbuhnwxk" \
    --form "created_at=2024-11-20T10:19:46" \
    --form "prioritization_impact=24" \
    --form "prioritization_confidence=66" \
    --form "prioritization_ease=73" \
    --form "prioritization_reach=51" \
    --form "moscow_priority=W" \
    --form "prioritization_color=egzisw" \
    --form "manual_bonus_votes=12" \
    --form "is_published=0" \
    --form "image=@/tmp/phpNaBk62" \
    --form "attachment=@/tmp/phpbHvar2" 
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'vylrdwkunllvi');
body.append('description', 'quas');
body.append('category_id', '15');
body.append('status_id', '14');
body.append('section_id', '12');
body.append('user_id', 'a85c05e3-2384-395e-b172-ae4d8d02c821');
body.append('allow_comments', 'true');
body.append('jira_key', 'numquam');
body.append('azure_boards_key', 'voluptas');
body.append('estimated_date', '2024-11-20T10:19:46');
body.append('tags[]', 'qlryzqumzhmvlujxivejbuhnwxk');
body.append('created_at', '2024-11-20T10:19:46');
body.append('prioritization_impact', '24');
body.append('prioritization_confidence', '66');
body.append('prioritization_ease', '73');
body.append('prioritization_reach', '51');
body.append('moscow_priority', 'W');
body.append('prioritization_color', 'egzisw');
body.append('manual_bonus_votes', '12');
body.append('is_published', '0');
body.append('image', document.querySelector('input[name="image"]').files[0]);
body.append('attachment', document.querySelector('input[name="attachment"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/posts',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'title',
                'contents' => 'vylrdwkunllvi'
            ],
            [
                'name' => 'description',
                'contents' => 'quas'
            ],
            [
                'name' => 'category_id',
                'contents' => '15'
            ],
            [
                'name' => 'status_id',
                'contents' => '14'
            ],
            [
                'name' => 'section_id',
                'contents' => '12'
            ],
            [
                'name' => 'user_id',
                'contents' => 'a85c05e3-2384-395e-b172-ae4d8d02c821'
            ],
            [
                'name' => 'allow_comments',
                'contents' => 'true'
            ],
            [
                'name' => 'jira_key',
                'contents' => 'numquam'
            ],
            [
                'name' => 'azure_boards_key',
                'contents' => 'voluptas'
            ],
            [
                'name' => 'estimated_date',
                'contents' => '2024-11-20T10:19:46'
            ],
            [
                'name' => 'tags[]',
                'contents' => 'qlryzqumzhmvlujxivejbuhnwxk'
            ],
            [
                'name' => 'created_at',
                'contents' => '2024-11-20T10:19:46'
            ],
            [
                'name' => 'prioritization_impact',
                'contents' => '24'
            ],
            [
                'name' => 'prioritization_confidence',
                'contents' => '66'
            ],
            [
                'name' => 'prioritization_ease',
                'contents' => '73'
            ],
            [
                'name' => 'prioritization_reach',
                'contents' => '51'
            ],
            [
                'name' => 'moscow_priority',
                'contents' => 'W'
            ],
            [
                'name' => 'prioritization_color',
                'contents' => 'egzisw'
            ],
            [
                'name' => 'manual_bonus_votes',
                'contents' => '12'
            ],
            [
                'name' => 'is_published',
                'contents' => '0'
            ],
            [
                'name' => 'image',
                'contents' => fopen('/tmp/phpNaBk62', 'r')
            ],
            [
                'name' => 'attachment',
                'contents' => fopen('/tmp/phpbHvar2', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts'
files = {
  'image': open('/tmp/phpNaBk62', 'rb'),
  'attachment': open('/tmp/phpbHvar2', 'rb')
}
payload = {
    "title": "vylrdwkunllvi",
    "description": "quas",
    "category_id": 15,
    "status_id": 14,
    "section_id": 12,
    "user_id": "a85c05e3-2384-395e-b172-ae4d8d02c821",
    "allow_comments": "true",
    "jira_key": "numquam",
    "azure_boards_key": "voluptas",
    "estimated_date": "2024-11-20T10:19:46",
    "tags": [
        "qlryzqumzhmvlujxivejbuhnwxk"
    ],
    "created_at": "2024-11-20T10:19:46",
    "prioritization_impact": 24,
    "prioritization_confidence": 66,
    "prioritization_ease": 73,
    "prioritization_reach": 51,
    "moscow_priority": "W",
    "prioritization_color": "egzisw",
    "manual_bonus_votes": 12,
    "is_published": "0"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, files=files, data=payload)
response.json()

Example response (404):


{
    "message": "No query results for model [App\\User] ..."
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
   "user_id": [
     "The user id must be a valid UUID."
   ]
}

Example response (200):


{
    "data": {
        "id": "WEukJy",
        "uid": "WEukJy-uid",
        "title": "Photo upload",
        "description_short": "It would be great if I can upload a photo.",
        "description": "It would be great if I can upload a photo. This feature would allow users to share visual content directly within the platform.",
        "description_changelog": "Added photo upload functionality to enhance user experience.",
        "clean_description_changelog": "Added photo upload functionality to enhance user experience.",
        "image_main": "https://example.com/images/photo-upload.jpg",
        "votes_count": 15,
        "comments_count": 3,
        "views_count": 100,
        "url": "https://your-portal-url.com/p/photo-upload-WEukJy",
        "url_edit": "https://your-portal-url.com/admin/posts/edit/WEukJy",
        "url_delete": "https://your-portal-url.com/admin/posts/delete/WEukJy",
        "created_at": "2023-05-15T10:00:00Z",
        "updated_at": "2023-05-16T14:30:00Z",
        "latest_status_change_at": "2023-05-16T14:30:00Z",
        "latest_status_change_at_formatted": "16 May 2023",
        "author": {
            "id": "420b8cfb-2c3d-4df2-b6bd-7ac6aae1a14a",
            "name": "Madalyn",
            "email": "robyn.oconner@example.net",
            "role": "member",
            "counter_votes": 4,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0
        },
        "categories": [
            {
                "id": 3,
                "name": "Integration",
                "color": "#FFAEA5"
            }
        ],
        "status": {
            "id": 3,
            "name": "💪 Now available",
            "color": "#FFCCB6",
            "tab_name": "Updates"
        },
        "section_id": 2,
        "moderation_status": "approved",
        "conversion": 0.75,
        "prioritization_impact": 8,
        "prioritization_confidence": 7,
        "prioritization_ease": 6,
        "prioritization_reach": 9
    }
}

Request   

POST api/v1/posts

Body Parameters

title  string  

Post title. Must be at least 2 characters. Must not be greater than 180 characters.

description  string optional  

Description of the post.

category_id  integer optional  

Optional category ID of the post. If not given or not found, no category will be added.

status_id  integer optional  

Optional status ID of the post. If not given or not found, the default status will be selected.

section_id  integer optional  

Optional section ID of the post. If not given or not found, it will be null.

user_id  string optional  

Optional user ID. If not given or not found, the post will be created from the logged in user or anonymous. Must be a valid UUID.

image  file optional  

Optional image. Must be an image. Must not be greater than 20480 kilobytes.

attachment  file optional  

Optional attachment. Must be a file. Must not be greater than 5240 kilobytes.

allow_comments  string optional  

Optional: Allow comments on this post. Defaults to true if not specified. Must be one of true, false, 0, or 1.

jira_key  string optional  

Optional: JIRA issue key associated with this post.

azure_boards_key  string optional  

Optional: Azure Boards work item key associated with this post.

estimated_date  string optional  

Optional: Estimated completion date for this post. Must be a valid date.

tags  string[] optional  

Each tag must be a string of at least 2 characters. Must be at least 2 characters. Must not be greater than 60 characters.

created_at  string optional  

Optional: Creation date of the post. Must be a valid date.

prioritization_impact  integer optional  

Optional: Impact score for prioritization (null or tinyint between 0 and 100). Must be between 0 and 100.

prioritization_confidence  integer optional  

Optional: Confidence score for prioritization (null or tinyint between 0 and 100). Must be between 0 and 100.

prioritization_ease  integer optional  

Optional: Ease score for prioritization (null or tinyint between 0 and 100). Must be between 0 and 100.

prioritization_reach  integer optional  

Optional: Reach score for prioritization (null or tinyint between 0 and 100). Must be between 0 and 100.

moscow_priority  string optional  

Optional: MoSCoW score for prioritization. (Can be null or M,S,C,W). Must be one of M, S, C, or W.

prioritization_color  string optional  

Optional: Color hex for status of prioritization. Must not be greater than 7 characters.

manual_bonus_votes  integer optional  

Optional: Manual bonus votes for the post.

is_published  string optional  

Optional: Publish as draft (false) or directly visible. Must be one of true, false, 0, or 1.

Get post

requires authentication

Retrieves the details of a specified post.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/posts/10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/10"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/posts/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/10'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):


{
    "message": "No query results for model [App\\Post] ..."
}

Example response (200):


{
    "data": {
        "id": "WEukJy",
        "uid": "WEukJy-uid",
        "title": "Photo upload",
        "description_short": "It would be great if I can upload a photo.",
        "description": "It would be great if I can upload a photo. This feature would allow users to share visual content directly within the platform.",
        "description_changelog": "Added photo upload functionality to enhance user experience.",
        "clean_description_changelog": "Added photo upload functionality to enhance user experience.",
        "image_main": "https://example.com/images/photo-upload.jpg",
        "votes_count": 15,
        "comments_count": 3,
        "views_count": 100,
        "url": "https://your-portal-url.com/p/photo-upload-WEukJy",
        "url_edit": "https://your-portal-url.com/admin/posts/edit/WEukJy",
        "url_delete": "https://your-portal-url.com/admin/posts/delete/WEukJy",
        "created_at": "2023-05-15T10:00:00Z",
        "updated_at": "2023-05-16T14:30:00Z",
        "latest_status_change_at": "2023-05-16T14:30:00Z",
        "latest_status_change_at_formatted": "16 May 2023",
        "author": {
            "id": "420b8cfb-2c3d-4df2-b6bd-7ac6aae1a14a",
            "name": "Madalyn",
            "email": "robyn.oconner@example.net",
            "role": "member",
            "counter_votes": 4,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0
        },
        "categories": [
            {
                "id": 3,
                "name": "Integration",
                "color": "#FFAEA5"
            }
        ],
        "status": {
            "id": 3,
            "name": "💪 Now available",
            "color": "#FFCCB6",
            "tab_name": "Updates"
        },
        "section_id": 2,
        "moderation_status": "approved",
        "conversion": 0.75,
        "prioritization_impact": 8,
        "prioritization_confidence": 7,
        "prioritization_ease": 6,
        "prioritization_reach": 9
    }
}

Request   

GET api/v1/posts/{post}

URL Parameters

post  integer  

id  string  

The ID of the post.

Update post

requires authentication

Updates the specified post by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This endpoint allows for updating the post's general attributes, status, and tags.

Example request:
curl --request PATCH \
    "{YOUR_PORTAL_URL}/api/v1/posts/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"tbjpitlrgysaqevnemxbcppxjgfghaindmoijjxmrptsgsmsuwyugeeaxfveqkaxcofcugppucuiyhnujvhticxdjasiwgxaciteigamyrncccqcarsnrdrkxagakxewtfpabyurd\",
    \"description\": \"quibusdam\",
    \"user_id\": \"e53c983a-5d45-3a71-9707-f16c18336ce3\",
    \"section_id\": 48724.1703,
    \"allow_comments\": \"0\",
    \"jira_key\": \"illo\",
    \"azure_boards_key\": \"odio\",
    \"estimated_date\": \"2024-11-20T10:19:46\",
    \"status\": 3001990.549283582,
    \"status_update_email\": \"vmgucvjorjoazpntefpwwlwaxjinysitonuheegxvsbpsgkggavhnibvqiihmjlzmrjonhaxlbrrandsuhrewqlpxcjyrjijrbazkrybmaqkxwsxhdfumgtfrshumyqrlgqkjaseknfdhbaytkvvoziosnkyskglpvnckyypuislzqoislhtpoiijlugyivhtevgizdcilcmuispqkfxrowembbptixiloezlelrgvvjghnguuaqltwaztpddynvfggfsclgxkbllbjoxeenjjvfsiumnywqtvjzxcwdcnkhfegctmpxtlnodxgckylxyfghumjoopbzyewyyzfcwsabpavdcaiqpylyzbchvxvnwyoibpscyvkzwysvqokpjkytsergfyopkzgfdnnfdckhqpdzenluzrzkrxivcojzxmjvgjayyzskgnomfllflocnxpwdclindibjtkumambmwfeswcjtpszghzxsbdhchnkfqnssgrazxdvwzwrfdqmkgpmhzjkovqwtrlnizerorhbfzbshumqfgmqdhfxomdrrhesvxaedwpstqmojkczmehfiiukjnbrzhkgzutgwnpkbkhfjsbiaviqzpqejzlmzolodiwnlgoifbxavqkrpzpjgouxilfnqogamctwbwesjmstsqvlrffivzrrbwyvnofvnpfrdblkktuqciqqsmtfemfiybruayzyhtwlrndiacljaudoskldbusncdnapwdchrvvchfifllsqjrufluayifpsmhiuyopounsxjcwubjtbucthfydyuiabmkqaisoymblbidyuumnzggnbybelmrdlqfwkatcnrsoqolencjrwhbmgaqanrnlffffomskvuqumboqxtynadmxvcmbvbiiphitehdgnbcadfnajexyqmzzdmxrebznjbhroefsscnadvaprwjrecwfawpmjbjmzzahywboflblelshshrbxzuvslijfmkhgeuvmgevqqkakdhcvwluzgkfxlxsnwguiwcspvlnivjdksiflnbbicndhcnkxovedqoatopplsgordvhbfeacerxahwirbgpawxcklxqxiocwnkomaxfzunnqlazakrqlsdnisphioymljmbdsyoeimhqhgtsszfbvhicnwdmcaohpllsujfzuworljtqqzeeqmxfsacuuwfgmerzstksrzivznnsbpkoqhibltwjliejantbtexfvrcctuifjzuywodppbsdkrqjkxwhyydjmibvmyeugneiedoljaryxjncbuqeselcrqojimetlebgsbipoycqrlnoblckikimevwnyqjjthslylxuclwbzpwotknooryfpugrgohgdauxaekwbzeuhhdekkevunngcrhncdhilcsjxzrjxgdiprjjzfgqhpblyjyjmwvutrrefoarlgbfqhcxzczrtyzpuvrugnbfifoerxvrxogaobrarjvwiwphdsjvaespzsxecfmysxhmfhimkhnrkfqlqxcswrepcdhfyucewalhfsljokpkyxaiemwxroxrcewvypiluwjdydkrqlydxr\",
    \"status_update_comment\": \"ldukfpeefizdrelzklfilzdpwuacdyvnblssibppgffgskqltyjlzeezirumqbhoytlgdepeacijalaekyaupastwiaqjweklukuzzadwpsszkpkrxvhrgvexsjcrmlfepvsqasxiezcsvgakjjmkydzxbcxmuddvyuhcvxixsyghrevbljwsaxhckwlofahkpybcphrbokorupzytkyevjolzgktigpivkyutkdssbequouqpkendtbezrekhpkmwmrlavnbsycbsjaxmoyyumtelmgkvhilagjogtidjlqjmrsxvycdomzajkkxajefcummyuzhksoktncxhbhborxyeugzkwvziefgssygixtmriszkfiswqgoqozqsousvfywtieejbeqwbvpnibneqdwsbmvsxzrdxhtcfztqbkpempnnnfdbsdoqizenhqsiimjebvqldtsxsgqfutpzdtonwribuxltbbjmgncjakjkrxjujyxtnscoehzmsrheiguatcqdvrrnugzzzpcpebjninxzlauhtucmankqlevyualhpwxzbeocjgeqnfsmggvclwkofftzchgqgteqzsvmlsccajqflwvhvrrnjrvvhkghomqqjquqynsdolkxuflxkwreynyvkagbrtjqmztaiogrxfwfxsshupiljlkvwxpvlpgtngeoufyrasywjhlgxkbmwszsaqtasxhtcaiqtcjyzjbwaenmypeprtjspltvldcllvjiiqclotzyzmfjmawipmrfwavhiemfhzvzijacbgxgayhkgeijctpkfnopvvfsuelonmtgvhtewwiqcmjfeeonktshxgtuiymwszsufkxcscbfxjsdzcxwdvxfqbeuyhcyfirzntvphpqugzhalrfywvqnqwkhmvwekppcqihopiucmmjsmezomwpcljsripstjydqkorhjantntgsdkcegeghiowffywhppqcdsrlrqwcfgheotntdetqsvhdapeweowgwqlllnakmhrupdnvmxighbpqqeshouadgolrkrbgyrgfrseferwduheobvwpmsqszxkaauhimgbdaldemlrcbxfxcoupkgismrrqrhezilocrqewteltjlsuvcgotbqsckcmsuktmjrmwbaibphwjrnoococugviajxshdfrxivnnistzhcmtxpyrwlueowclyemijgpzwhehijeqdihsylugqxmzioaeujxznunhztatoyjsltrhvsjtlkqyxogwgzcbtzzpmfqqvtuwrycngtkxbejir\",
    \"status_update_replace_prior\": \"iure\",
    \"status_update_comment_tagged_for_changelog\": \"false\",
    \"status_update_comment_pinned_to_top\": \"false\",
    \"tags\": [
        \"dmy\"
    ],
    \"category_id\": 4,
    \"created_at\": \"2024-11-20T10:19:46\",
    \"prioritization_impact\": 84,
    \"prioritization_confidence\": 63,
    \"prioritization_ease\": 51,
    \"prioritization_reach\": 43,
    \"moscow_priority\": \"S\",
    \"prioritization_color\": \"i\",
    \"manual_bonus_votes\": 2,
    \"is_published\": \"0\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "tbjpitlrgysaqevnemxbcppxjgfghaindmoijjxmrptsgsmsuwyugeeaxfveqkaxcofcugppucuiyhnujvhticxdjasiwgxaciteigamyrncccqcarsnrdrkxagakxewtfpabyurd",
    "description": "quibusdam",
    "user_id": "e53c983a-5d45-3a71-9707-f16c18336ce3",
    "section_id": 48724.1703,
    "allow_comments": "0",
    "jira_key": "illo",
    "azure_boards_key": "odio",
    "estimated_date": "2024-11-20T10:19:46",
    "status": 3001990.549283582,
    "status_update_email": "vmgucvjorjoazpntefpwwlwaxjinysitonuheegxvsbpsgkggavhnibvqiihmjlzmrjonhaxlbrrandsuhrewqlpxcjyrjijrbazkrybmaqkxwsxhdfumgtfrshumyqrlgqkjaseknfdhbaytkvvoziosnkyskglpvnckyypuislzqoislhtpoiijlugyivhtevgizdcilcmuispqkfxrowembbptixiloezlelrgvvjghnguuaqltwaztpddynvfggfsclgxkbllbjoxeenjjvfsiumnywqtvjzxcwdcnkhfegctmpxtlnodxgckylxyfghumjoopbzyewyyzfcwsabpavdcaiqpylyzbchvxvnwyoibpscyvkzwysvqokpjkytsergfyopkzgfdnnfdckhqpdzenluzrzkrxivcojzxmjvgjayyzskgnomfllflocnxpwdclindibjtkumambmwfeswcjtpszghzxsbdhchnkfqnssgrazxdvwzwrfdqmkgpmhzjkovqwtrlnizerorhbfzbshumqfgmqdhfxomdrrhesvxaedwpstqmojkczmehfiiukjnbrzhkgzutgwnpkbkhfjsbiaviqzpqejzlmzolodiwnlgoifbxavqkrpzpjgouxilfnqogamctwbwesjmstsqvlrffivzrrbwyvnofvnpfrdblkktuqciqqsmtfemfiybruayzyhtwlrndiacljaudoskldbusncdnapwdchrvvchfifllsqjrufluayifpsmhiuyopounsxjcwubjtbucthfydyuiabmkqaisoymblbidyuumnzggnbybelmrdlqfwkatcnrsoqolencjrwhbmgaqanrnlffffomskvuqumboqxtynadmxvcmbvbiiphitehdgnbcadfnajexyqmzzdmxrebznjbhroefsscnadvaprwjrecwfawpmjbjmzzahywboflblelshshrbxzuvslijfmkhgeuvmgevqqkakdhcvwluzgkfxlxsnwguiwcspvlnivjdksiflnbbicndhcnkxovedqoatopplsgordvhbfeacerxahwirbgpawxcklxqxiocwnkomaxfzunnqlazakrqlsdnisphioymljmbdsyoeimhqhgtsszfbvhicnwdmcaohpllsujfzuworljtqqzeeqmxfsacuuwfgmerzstksrzivznnsbpkoqhibltwjliejantbtexfvrcctuifjzuywodppbsdkrqjkxwhyydjmibvmyeugneiedoljaryxjncbuqeselcrqojimetlebgsbipoycqrlnoblckikimevwnyqjjthslylxuclwbzpwotknooryfpugrgohgdauxaekwbzeuhhdekkevunngcrhncdhilcsjxzrjxgdiprjjzfgqhpblyjyjmwvutrrefoarlgbfqhcxzczrtyzpuvrugnbfifoerxvrxogaobrarjvwiwphdsjvaespzsxecfmysxhmfhimkhnrkfqlqxcswrepcdhfyucewalhfsljokpkyxaiemwxroxrcewvypiluwjdydkrqlydxr",
    "status_update_comment": "ldukfpeefizdrelzklfilzdpwuacdyvnblssibppgffgskqltyjlzeezirumqbhoytlgdepeacijalaekyaupastwiaqjweklukuzzadwpsszkpkrxvhrgvexsjcrmlfepvsqasxiezcsvgakjjmkydzxbcxmuddvyuhcvxixsyghrevbljwsaxhckwlofahkpybcphrbokorupzytkyevjolzgktigpivkyutkdssbequouqpkendtbezrekhpkmwmrlavnbsycbsjaxmoyyumtelmgkvhilagjogtidjlqjmrsxvycdomzajkkxajefcummyuzhksoktncxhbhborxyeugzkwvziefgssygixtmriszkfiswqgoqozqsousvfywtieejbeqwbvpnibneqdwsbmvsxzrdxhtcfztqbkpempnnnfdbsdoqizenhqsiimjebvqldtsxsgqfutpzdtonwribuxltbbjmgncjakjkrxjujyxtnscoehzmsrheiguatcqdvrrnugzzzpcpebjninxzlauhtucmankqlevyualhpwxzbeocjgeqnfsmggvclwkofftzchgqgteqzsvmlsccajqflwvhvrrnjrvvhkghomqqjquqynsdolkxuflxkwreynyvkagbrtjqmztaiogrxfwfxsshupiljlkvwxpvlpgtngeoufyrasywjhlgxkbmwszsaqtasxhtcaiqtcjyzjbwaenmypeprtjspltvldcllvjiiqclotzyzmfjmawipmrfwavhiemfhzvzijacbgxgayhkgeijctpkfnopvvfsuelonmtgvhtewwiqcmjfeeonktshxgtuiymwszsufkxcscbfxjsdzcxwdvxfqbeuyhcyfirzntvphpqugzhalrfywvqnqwkhmvwekppcqihopiucmmjsmezomwpcljsripstjydqkorhjantntgsdkcegeghiowffywhppqcdsrlrqwcfgheotntdetqsvhdapeweowgwqlllnakmhrupdnvmxighbpqqeshouadgolrkrbgyrgfrseferwduheobvwpmsqszxkaauhimgbdaldemlrcbxfxcoupkgismrrqrhezilocrqewteltjlsuvcgotbqsckcmsuktmjrmwbaibphwjrnoococugviajxshdfrxivnnistzhcmtxpyrwlueowclyemijgpzwhehijeqdihsylugqxmzioaeujxznunhztatoyjsltrhvsjtlkqyxogwgzcbtzzpmfqqvtuwrycngtkxbejir",
    "status_update_replace_prior": "iure",
    "status_update_comment_tagged_for_changelog": "false",
    "status_update_comment_pinned_to_top": "false",
    "tags": [
        "dmy"
    ],
    "category_id": 4,
    "created_at": "2024-11-20T10:19:46",
    "prioritization_impact": 84,
    "prioritization_confidence": 63,
    "prioritization_ease": 51,
    "prioritization_reach": 43,
    "moscow_priority": "S",
    "prioritization_color": "i",
    "manual_bonus_votes": 2,
    "is_published": "0"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    '{YOUR_PORTAL_URL}/api/v1/posts/18',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'tbjpitlrgysaqevnemxbcppxjgfghaindmoijjxmrptsgsmsuwyugeeaxfveqkaxcofcugppucuiyhnujvhticxdjasiwgxaciteigamyrncccqcarsnrdrkxagakxewtfpabyurd',
            'description' => 'quibusdam',
            'user_id' => 'e53c983a-5d45-3a71-9707-f16c18336ce3',
            'section_id' => 48724.1703,
            'allow_comments' => '0',
            'jira_key' => 'illo',
            'azure_boards_key' => 'odio',
            'estimated_date' => '2024-11-20T10:19:46',
            'status' => 3001990.549283582,
            'status_update_email' => 'vmgucvjorjoazpntefpwwlwaxjinysitonuheegxvsbpsgkggavhnibvqiihmjlzmrjonhaxlbrrandsuhrewqlpxcjyrjijrbazkrybmaqkxwsxhdfumgtfrshumyqrlgqkjaseknfdhbaytkvvoziosnkyskglpvnckyypuislzqoislhtpoiijlugyivhtevgizdcilcmuispqkfxrowembbptixiloezlelrgvvjghnguuaqltwaztpddynvfggfsclgxkbllbjoxeenjjvfsiumnywqtvjzxcwdcnkhfegctmpxtlnodxgckylxyfghumjoopbzyewyyzfcwsabpavdcaiqpylyzbchvxvnwyoibpscyvkzwysvqokpjkytsergfyopkzgfdnnfdckhqpdzenluzrzkrxivcojzxmjvgjayyzskgnomfllflocnxpwdclindibjtkumambmwfeswcjtpszghzxsbdhchnkfqnssgrazxdvwzwrfdqmkgpmhzjkovqwtrlnizerorhbfzbshumqfgmqdhfxomdrrhesvxaedwpstqmojkczmehfiiukjnbrzhkgzutgwnpkbkhfjsbiaviqzpqejzlmzolodiwnlgoifbxavqkrpzpjgouxilfnqogamctwbwesjmstsqvlrffivzrrbwyvnofvnpfrdblkktuqciqqsmtfemfiybruayzyhtwlrndiacljaudoskldbusncdnapwdchrvvchfifllsqjrufluayifpsmhiuyopounsxjcwubjtbucthfydyuiabmkqaisoymblbidyuumnzggnbybelmrdlqfwkatcnrsoqolencjrwhbmgaqanrnlffffomskvuqumboqxtynadmxvcmbvbiiphitehdgnbcadfnajexyqmzzdmxrebznjbhroefsscnadvaprwjrecwfawpmjbjmzzahywboflblelshshrbxzuvslijfmkhgeuvmgevqqkakdhcvwluzgkfxlxsnwguiwcspvlnivjdksiflnbbicndhcnkxovedqoatopplsgordvhbfeacerxahwirbgpawxcklxqxiocwnkomaxfzunnqlazakrqlsdnisphioymljmbdsyoeimhqhgtsszfbvhicnwdmcaohpllsujfzuworljtqqzeeqmxfsacuuwfgmerzstksrzivznnsbpkoqhibltwjliejantbtexfvrcctuifjzuywodppbsdkrqjkxwhyydjmibvmyeugneiedoljaryxjncbuqeselcrqojimetlebgsbipoycqrlnoblckikimevwnyqjjthslylxuclwbzpwotknooryfpugrgohgdauxaekwbzeuhhdekkevunngcrhncdhilcsjxzrjxgdiprjjzfgqhpblyjyjmwvutrrefoarlgbfqhcxzczrtyzpuvrugnbfifoerxvrxogaobrarjvwiwphdsjvaespzsxecfmysxhmfhimkhnrkfqlqxcswrepcdhfyucewalhfsljokpkyxaiemwxroxrcewvypiluwjdydkrqlydxr',
            'status_update_comment' => 'ldukfpeefizdrelzklfilzdpwuacdyvnblssibppgffgskqltyjlzeezirumqbhoytlgdepeacijalaekyaupastwiaqjweklukuzzadwpsszkpkrxvhrgvexsjcrmlfepvsqasxiezcsvgakjjmkydzxbcxmuddvyuhcvxixsyghrevbljwsaxhckwlofahkpybcphrbokorupzytkyevjolzgktigpivkyutkdssbequouqpkendtbezrekhpkmwmrlavnbsycbsjaxmoyyumtelmgkvhilagjogtidjlqjmrsxvycdomzajkkxajefcummyuzhksoktncxhbhborxyeugzkwvziefgssygixtmriszkfiswqgoqozqsousvfywtieejbeqwbvpnibneqdwsbmvsxzrdxhtcfztqbkpempnnnfdbsdoqizenhqsiimjebvqldtsxsgqfutpzdtonwribuxltbbjmgncjakjkrxjujyxtnscoehzmsrheiguatcqdvrrnugzzzpcpebjninxzlauhtucmankqlevyualhpwxzbeocjgeqnfsmggvclwkofftzchgqgteqzsvmlsccajqflwvhvrrnjrvvhkghomqqjquqynsdolkxuflxkwreynyvkagbrtjqmztaiogrxfwfxsshupiljlkvwxpvlpgtngeoufyrasywjhlgxkbmwszsaqtasxhtcaiqtcjyzjbwaenmypeprtjspltvldcllvjiiqclotzyzmfjmawipmrfwavhiemfhzvzijacbgxgayhkgeijctpkfnopvvfsuelonmtgvhtewwiqcmjfeeonktshxgtuiymwszsufkxcscbfxjsdzcxwdvxfqbeuyhcyfirzntvphpqugzhalrfywvqnqwkhmvwekppcqihopiucmmjsmezomwpcljsripstjydqkorhjantntgsdkcegeghiowffywhppqcdsrlrqwcfgheotntdetqsvhdapeweowgwqlllnakmhrupdnvmxighbpqqeshouadgolrkrbgyrgfrseferwduheobvwpmsqszxkaauhimgbdaldemlrcbxfxcoupkgismrrqrhezilocrqewteltjlsuvcgotbqsckcmsuktmjrmwbaibphwjrnoococugviajxshdfrxivnnistzhcmtxpyrwlueowclyemijgpzwhehijeqdihsylugqxmzioaeujxznunhztatoyjsltrhvsjtlkqyxogwgzcbtzzpmfqqvtuwrycngtkxbejir',
            'status_update_replace_prior' => 'iure',
            'status_update_comment_tagged_for_changelog' => 'false',
            'status_update_comment_pinned_to_top' => 'false',
            'tags' => [
                'dmy',
            ],
            'category_id' => 4,
            'created_at' => '2024-11-20T10:19:46',
            'prioritization_impact' => 84,
            'prioritization_confidence' => 63,
            'prioritization_ease' => 51,
            'prioritization_reach' => 43,
            'moscow_priority' => 'S',
            'prioritization_color' => 'i',
            'manual_bonus_votes' => 2,
            'is_published' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/18'
payload = {
    "title": "tbjpitlrgysaqevnemxbcppxjgfghaindmoijjxmrptsgsmsuwyugeeaxfveqkaxcofcugppucuiyhnujvhticxdjasiwgxaciteigamyrncccqcarsnrdrkxagakxewtfpabyurd",
    "description": "quibusdam",
    "user_id": "e53c983a-5d45-3a71-9707-f16c18336ce3",
    "section_id": 48724.1703,
    "allow_comments": "0",
    "jira_key": "illo",
    "azure_boards_key": "odio",
    "estimated_date": "2024-11-20T10:19:46",
    "status": 3001990.549283582,
    "status_update_email": "vmgucvjorjoazpntefpwwlwaxjinysitonuheegxvsbpsgkggavhnibvqiihmjlzmrjonhaxlbrrandsuhrewqlpxcjyrjijrbazkrybmaqkxwsxhdfumgtfrshumyqrlgqkjaseknfdhbaytkvvoziosnkyskglpvnckyypuislzqoislhtpoiijlugyivhtevgizdcilcmuispqkfxrowembbptixiloezlelrgvvjghnguuaqltwaztpddynvfggfsclgxkbllbjoxeenjjvfsiumnywqtvjzxcwdcnkhfegctmpxtlnodxgckylxyfghumjoopbzyewyyzfcwsabpavdcaiqpylyzbchvxvnwyoibpscyvkzwysvqokpjkytsergfyopkzgfdnnfdckhqpdzenluzrzkrxivcojzxmjvgjayyzskgnomfllflocnxpwdclindibjtkumambmwfeswcjtpszghzxsbdhchnkfqnssgrazxdvwzwrfdqmkgpmhzjkovqwtrlnizerorhbfzbshumqfgmqdhfxomdrrhesvxaedwpstqmojkczmehfiiukjnbrzhkgzutgwnpkbkhfjsbiaviqzpqejzlmzolodiwnlgoifbxavqkrpzpjgouxilfnqogamctwbwesjmstsqvlrffivzrrbwyvnofvnpfrdblkktuqciqqsmtfemfiybruayzyhtwlrndiacljaudoskldbusncdnapwdchrvvchfifllsqjrufluayifpsmhiuyopounsxjcwubjtbucthfydyuiabmkqaisoymblbidyuumnzggnbybelmrdlqfwkatcnrsoqolencjrwhbmgaqanrnlffffomskvuqumboqxtynadmxvcmbvbiiphitehdgnbcadfnajexyqmzzdmxrebznjbhroefsscnadvaprwjrecwfawpmjbjmzzahywboflblelshshrbxzuvslijfmkhgeuvmgevqqkakdhcvwluzgkfxlxsnwguiwcspvlnivjdksiflnbbicndhcnkxovedqoatopplsgordvhbfeacerxahwirbgpawxcklxqxiocwnkomaxfzunnqlazakrqlsdnisphioymljmbdsyoeimhqhgtsszfbvhicnwdmcaohpllsujfzuworljtqqzeeqmxfsacuuwfgmerzstksrzivznnsbpkoqhibltwjliejantbtexfvrcctuifjzuywodppbsdkrqjkxwhyydjmibvmyeugneiedoljaryxjncbuqeselcrqojimetlebgsbipoycqrlnoblckikimevwnyqjjthslylxuclwbzpwotknooryfpugrgohgdauxaekwbzeuhhdekkevunngcrhncdhilcsjxzrjxgdiprjjzfgqhpblyjyjmwvutrrefoarlgbfqhcxzczrtyzpuvrugnbfifoerxvrxogaobrarjvwiwphdsjvaespzsxecfmysxhmfhimkhnrkfqlqxcswrepcdhfyucewalhfsljokpkyxaiemwxroxrcewvypiluwjdydkrqlydxr",
    "status_update_comment": "ldukfpeefizdrelzklfilzdpwuacdyvnblssibppgffgskqltyjlzeezirumqbhoytlgdepeacijalaekyaupastwiaqjweklukuzzadwpsszkpkrxvhrgvexsjcrmlfepvsqasxiezcsvgakjjmkydzxbcxmuddvyuhcvxixsyghrevbljwsaxhckwlofahkpybcphrbokorupzytkyevjolzgktigpivkyutkdssbequouqpkendtbezrekhpkmwmrlavnbsycbsjaxmoyyumtelmgkvhilagjogtidjlqjmrsxvycdomzajkkxajefcummyuzhksoktncxhbhborxyeugzkwvziefgssygixtmriszkfiswqgoqozqsousvfywtieejbeqwbvpnibneqdwsbmvsxzrdxhtcfztqbkpempnnnfdbsdoqizenhqsiimjebvqldtsxsgqfutpzdtonwribuxltbbjmgncjakjkrxjujyxtnscoehzmsrheiguatcqdvrrnugzzzpcpebjninxzlauhtucmankqlevyualhpwxzbeocjgeqnfsmggvclwkofftzchgqgteqzsvmlsccajqflwvhvrrnjrvvhkghomqqjquqynsdolkxuflxkwreynyvkagbrtjqmztaiogrxfwfxsshupiljlkvwxpvlpgtngeoufyrasywjhlgxkbmwszsaqtasxhtcaiqtcjyzjbwaenmypeprtjspltvldcllvjiiqclotzyzmfjmawipmrfwavhiemfhzvzijacbgxgayhkgeijctpkfnopvvfsuelonmtgvhtewwiqcmjfeeonktshxgtuiymwszsufkxcscbfxjsdzcxwdvxfqbeuyhcyfirzntvphpqugzhalrfywvqnqwkhmvwekppcqihopiucmmjsmezomwpcljsripstjydqkorhjantntgsdkcegeghiowffywhppqcdsrlrqwcfgheotntdetqsvhdapeweowgwqlllnakmhrupdnvmxighbpqqeshouadgolrkrbgyrgfrseferwduheobvwpmsqszxkaauhimgbdaldemlrcbxfxcoupkgismrrqrhezilocrqewteltjlsuvcgotbqsckcmsuktmjrmwbaibphwjrnoococugviajxshdfrxivnnistzhcmtxpyrwlueowclyemijgpzwhehijeqdihsylugqxmzioaeujxznunhztatoyjsltrhvsjtlkqyxogwgzcbtzzpmfqqvtuwrycngtkxbejir",
    "status_update_replace_prior": "iure",
    "status_update_comment_tagged_for_changelog": "false",
    "status_update_comment_pinned_to_top": "false",
    "tags": [
        "dmy"
    ],
    "category_id": 4,
    "created_at": "2024-11-20T10:19:46",
    "prioritization_impact": 84,
    "prioritization_confidence": 63,
    "prioritization_ease": 51,
    "prioritization_reach": 43,
    "moscow_priority": "S",
    "prioritization_color": "i",
    "manual_bonus_votes": 2,
    "is_published": "0"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Example response (404):


{
    "message": "No query results for model [App\\Post] ..."
}

Example response (404):


{
    "message": "No query results for model [App\\User] ..."
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
   "user_id": [
     "The user id must be a valid UUID."
   ]
}

Example response (200):


{
    "data": {
        "id": "WEukJy",
        "uid": "WEukJy-uid",
        "title": "Photo upload",
        "description_short": "It would be great if I can upload a photo.",
        "description": "It would be great if I can upload a photo. This feature would allow users to share visual content directly within the platform.",
        "description_changelog": "Added photo upload functionality to enhance user experience.",
        "clean_description_changelog": "Added photo upload functionality to enhance user experience.",
        "image_main": "https://example.com/images/photo-upload.jpg",
        "votes_count": 15,
        "comments_count": 3,
        "views_count": 100,
        "url": "https://your-portal-url.com/p/photo-upload-WEukJy",
        "url_edit": "https://your-portal-url.com/admin/posts/edit/WEukJy",
        "url_delete": "https://your-portal-url.com/admin/posts/delete/WEukJy",
        "created_at": "2023-05-15T10:00:00Z",
        "updated_at": "2023-05-16T14:30:00Z",
        "latest_status_change_at": "2023-05-16T14:30:00Z",
        "latest_status_change_at_formatted": "16 May 2023",
        "author": {
            "id": "420b8cfb-2c3d-4df2-b6bd-7ac6aae1a14a",
            "name": "Madalyn",
            "email": "robyn.oconner@example.net",
            "role": "member",
            "counter_votes": 4,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0
        },
        "categories": [
            {
                "id": 3,
                "name": "Integration",
                "color": "#FFAEA5"
            }
        ],
        "status": {
            "id": 3,
            "name": "💪 Now available",
            "color": "#FFCCB6",
            "tab_name": "Updates"
        },
        "section_id": 2,
        "moderation_status": "approved",
        "conversion": 0.75,
        "prioritization_impact": 8,
        "prioritization_confidence": 7,
        "prioritization_ease": 6,
        "prioritization_reach": 9
    }
}

Request   

PATCH api/v1/posts/{post}

URL Parameters

post  integer  

key  string  

The unique key of the post.

Body Parameters

title  string optional  

Optionally adjust the post title. Must be at least 2 characters. Must not be greater than 180 characters.

description  string optional  

Optionally adjust the description of the post.

user_id  string optional  

Optionally adjust user ID. If NULL is given, the post will become anonymous. Must be a valid UUID.

section_id  number optional  

Optional section ID for the post.

allow_comments  string optional  

Optionally adjust whether comments are allowed on this post. Must be one of true, false, 0, or 1.

jira_key  string optional  

Optionally adjust the JIRA issue key associated with this post.

azure_boards_key  string optional  

Optionally adjust the Azure Boards work item key associated with this post.

estimated_date  string optional  

Optionally adjust the estimated completion date for this post. Must be a valid date.

status  number optional  

The new status ID for the post.

status_update_email  string optional  

The message to be sent in the email notification about the status change. Must not be greater than 6000 characters.

status_update_comment  string optional  

The message to be added as a comment about the status change. Must not be greater than 6000 characters.

status_update_replace_prior  string optional  

Indicates whether to replace the prior status.

status_update_comment_tagged_for_changelog  string optional  

Indicates whether to use this status change comment for the changelog. Must be one of true, false, 0, or 1.

status_update_comment_pinned_to_top  string optional  

Indicates whether to pin this post to the top after the status change and use the comment for changelog. Must be one of true, false, 0, or 1.

tags  string[] optional  

Each tag must be a string of at least 2 characters. Must be at least 2 characters. Must not be greater than 60 characters.

category_id  integer optional  

Optional category ID of the post.

created_at  string optional  

Optional creation date of the post. Must be a valid date.

prioritization_impact  integer optional  

Optional: Impact score for prioritization (null or integer between 0 and 100). Must be between 0 and 100.

prioritization_confidence  integer optional  

Optional: Confidence score for prioritization (null or integer between 0 and 100). Must be between 0 and 100.

prioritization_ease  integer optional  

Optional: Ease score for prioritization (null or integer between 0 and 100). Must be between 0 and 100.

prioritization_reach  integer optional  

Optional: Reach score for prioritization (null or integer between 0 and 100). Must be between 0 and 100.

moscow_priority  string optional  

Optional: MoSCoW score for prioritization. (Can be null or M,S,C,W). Must be one of M, S, C, or W.

prioritization_color  string optional  

Optional: Color hex for status of prioritization. Must not be greater than 7 characters.

manual_bonus_votes  integer optional  

Optional: Manual bonus votes for the post.

is_published  string optional  

Optional: Publish as draft (false) or directly visible. Must be one of true, false, 0, or 1.

Delete post

requires authentication

Deletes a specified post.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/posts/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/posts/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/2'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\Post] ..."
}

Request   

DELETE api/v1/posts/{post}

URL Parameters

post  integer  

id  string  

The ID of the post.

List posts

requires authentication

Retrieves a complete list of posts from your portal. Includes a "hasMore" attribute indicating if additional posts exist beyond the specified query limit.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/posts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 59,
    \"skip\": 11,
    \"order_by\": \"moscow_priority\",
    \"order_direction\": \"desc\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": 59,
    "skip": 11,
    "order_by": "moscow_priority",
    "order_direction": "desc"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/posts',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'limit' => 59,
            'skip' => 11,
            'order_by' => 'moscow_priority',
            'order_direction' => 'desc',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts'
payload = {
    "limit": 59,
    "skip": 11,
    "order_by": "moscow_priority",
    "order_direction": "desc"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (200, success):


{
    "data": [
        {
            "id": "WEukJy",
            "uid": "WEukJy-uid",
            "title": "Photo upload",
            "description_short": "It would be great if I can upload a photo.",
            "description": "It would be great if I can upload a photo. This feature would allow users to share visual content directly within the platform.",
            "description_changelog": "Added photo upload functionality to enhance user experience.",
            "clean_description_changelog": "Added photo upload functionality to enhance user experience.",
            "image_main": "https://example.com/images/photo-upload.jpg",
            "votes_count": 15,
            "comments_count": 3,
            "views_count": 100,
            "url": "https://your-portal-url.com/p/photo-upload-WEukJy",
            "url_edit": "https://your-portal-url.com/admin/posts/edit/WEukJy",
            "url_delete": "https://your-portal-url.com/admin/posts/delete/WEukJy",
            "created_at": "2023-05-15T10:00:00Z",
            "updated_at": "2023-05-16T14:30:00Z",
            "latest_status_change_at": "2023-05-16T14:30:00Z",
            "latest_status_change_at_formatted": "16 May 2023",
            "author": {
                "id": "420b8cfb-2c3d-4df2-b6bd-7ac6aae1a14a",
                "name": "Madalyn",
                "email": "robyn.oconner@example.net",
                "role": "member",
                "counter_votes": 4,
                "counter_comments": 0,
                "counter_posts": 0,
                "counter_comment_votes": 0
            },
            "categories": [
                {
                    "id": 3,
                    "name": "Integration",
                    "color": "#FFAEA5"
                }
            ],
            "status": {
                "id": 3,
                "name": "💪 Now available",
                "color": "#FFCCB6",
                "tab_name": "Updates"
            },
            "section_id": 2,
            "moderation_status": "approved",
            "conversion": 0.75,
            "prioritization_impact": 8,
            "prioritization_confidence": 7,
            "prioritization_ease": 6,
            "prioritization_reach": 9
        }
    ],
    "hasMore": false,
    "total": 1,
    "skip": 0,
    "limit": 10
}

Request   

GET api/v1/posts

Body Parameters

tab  string optional  

Optional tab url to filter on the tab, example: roadmap.

category  string optional  

Optional category ID of the posts.

section  string optional  

Optional section ID of the posts.

limit  integer optional  

A limit on the number of posts to be returned. Limit can range between 1 and 100, and the default is 10. Must be at least 1. Must not be greater than 100.

skip  integer optional  

The number of posts you'd like to skip before starting to fetch. Defaults to 0 if not specified.

status  string optional  

Optional status of the posts. Can also be an array of statuses.

order_by  string optional  

Optional: Field to order by, options: title,created_at,updated_at,votes_count,comments_count,latest_status_change,order (where order is manually ordering). Must be one of title, created_at, updated_at, votes_count, comments_count, latest_status_change, order, or moscow_priority.

order_direction  string optional  

Optional: Order direction (asc or desc). Must be one of asc or desc.

Product Vision

Handles operations related to product vision including viewing, creating, updating, deleting, and generating vision boards.

Get product vision

requires authentication

Retrieves the current product vision.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/product-vision" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/product-vision"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/product-vision',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/product-vision'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/v1/product-vision

Delete product vision

requires authentication

Removes the current product vision.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/product-vision" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/product-vision"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/product-vision',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/product-vision'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE api/v1/product-vision

Create or update product vision

requires authentication

Stores a new product vision or updates the existing one.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/product-vision" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/product-vision"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/product-vision',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/product-vision'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST api/v1/product-vision

Generate product vision

requires authentication

Creates a product vision board using AI based on the provided description.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/product-vision/generate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/product-vision/generate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/product-vision/generate',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/product-vision/generate'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST api/v1/product-vision/generate

Sections

Manages operations related to sections within tabs, including creation, updating, deletion, and reordering.

Create section

requires authentication

Creates a new section within a specified tab.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/sections" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vuwtkugqjhaetwnumzchrvsrrklofjksnfzjwkpkcnnzmtryqvzuphvfb\",
    \"description\": \"axmxksdyfanhbqrgpdidsdpoqzu\",
    \"icon\": \"pgadozbvlwsap\",
    \"tab_id\": 1,
    \"after_id\": 0,
    \"color\": \"bz\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/sections"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vuwtkugqjhaetwnumzchrvsrrklofjksnfzjwkpkcnnzmtryqvzuphvfb",
    "description": "axmxksdyfanhbqrgpdidsdpoqzu",
    "icon": "pgadozbvlwsap",
    "tab_id": 1,
    "after_id": 0,
    "color": "bz"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/sections',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'vuwtkugqjhaetwnumzchrvsrrklofjksnfzjwkpkcnnzmtryqvzuphvfb',
            'description' => 'axmxksdyfanhbqrgpdidsdpoqzu',
            'icon' => 'pgadozbvlwsap',
            'tab_id' => 1,
            'after_id' => 0,
            'color' => 'bz',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/sections'
payload = {
    "title": "vuwtkugqjhaetwnumzchrvsrrklofjksnfzjwkpkcnnzmtryqvzuphvfb",
    "description": "axmxksdyfanhbqrgpdidsdpoqzu",
    "icon": "pgadozbvlwsap",
    "tab_id": 1,
    "after_id": 0,
    "color": "bz"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 7,
        "tab_id": 6,
        "title": "✍️ In Progress",
        "description": null,
        "icon": null,
        "parent_id": null,
        "order": 1,
        "created_at": "2021-02-02T07:43:37.000000Z",
        "updated_at": "2024-04-24T09:23:50.000000Z",
        "is_hidden_for_users": 0,
        "color": null
    }
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "title": [
            "The title has already been taken."
        ]
    }
}

Request   

POST api/v1/sections

Body Parameters

title  string  

Must be at least 2 characters. Must not be greater than 60 characters.

description  string optional  

Must not be greater than 255 characters.

icon  string optional  

Must not be greater than 50 characters.

tab_id  number  

Must be at least 1.

parent_id  string optional  

after_id  number optional  

Must be at least 1.

color  string optional  

Must not be greater than 7 characters.

Update Section

requires authentication

Modifies the details of an existing section.

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/sections/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"qkaevxkrvmwfqqrwotgt\",
    \"description\": \"clcbbivducpznsbepxbzvqcqvmvypxosofjmdpciskyqhzggccxrbpbrxktwifvrybyidfxubmjrkhawexwwhodzpntsndubdjlxmkshoxjmbdimsklcdonuhabkmgesvikhpoomoivgseyolyl\",
    \"icon\": \"nwdsjwnmcci\",
    \"is_hidden_for_users\": false,
    \"color\": \"iilgnku\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/sections/11"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "qkaevxkrvmwfqqrwotgt",
    "description": "clcbbivducpznsbepxbzvqcqvmvypxosofjmdpciskyqhzggccxrbpbrxktwifvrybyidfxubmjrkhawexwwhodzpntsndubdjlxmkshoxjmbdimsklcdonuhabkmgesvikhpoomoivgseyolyl",
    "icon": "nwdsjwnmcci",
    "is_hidden_for_users": false,
    "color": "iilgnku"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/sections/11',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'qkaevxkrvmwfqqrwotgt',
            'description' => 'clcbbivducpznsbepxbzvqcqvmvypxosofjmdpciskyqhzggccxrbpbrxktwifvrybyidfxubmjrkhawexwwhodzpntsndubdjlxmkshoxjmbdimsklcdonuhabkmgesvikhpoomoivgseyolyl',
            'icon' => 'nwdsjwnmcci',
            'is_hidden_for_users' => false,
            'color' => 'iilgnku',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/sections/11'
payload = {
    "title": "qkaevxkrvmwfqqrwotgt",
    "description": "clcbbivducpznsbepxbzvqcqvmvypxosofjmdpciskyqhzggccxrbpbrxktwifvrybyidfxubmjrkhawexwwhodzpntsndubdjlxmkshoxjmbdimsklcdonuhabkmgesvikhpoomoivgseyolyl",
    "icon": "nwdsjwnmcci",
    "is_hidden_for_users": false,
    "color": "iilgnku"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 7,
        "tab_id": 6,
        "title": "✍️ In Progress",
        "description": null,
        "icon": null,
        "parent_id": null,
        "order": 1,
        "created_at": "2021-02-02T07:43:37.000000Z",
        "updated_at": "2024-04-24T09:23:50.000000Z",
        "is_hidden_for_users": 0,
        "color": null
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Section] ..."
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "title": [
            "The title must be given."
        ]
    }
}

Request   

PUT api/v1/sections/{id}

URL Parameters

id  integer  

The ID of the section.

Body Parameters

title  string  

Must be at least 2 characters. Must not be greater than 60 characters.

description  string optional  

Must not be greater than 255 characters.

icon  string optional  

Must not be greater than 50 characters.

is_hidden_for_users  boolean optional  

parent_id  string optional  

color  string optional  

Must not be greater than 7 characters.

Delete Section

requires authentication

Removes a specified section from the database.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/sections/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/sections/15"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/sections/15',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/sections/15'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\Section] ..."
}

Request   

DELETE api/v1/sections/{id}

URL Parameters

id  integer  

The ID of the section.

List sections

requires authentication

Retrieves all sections for a specified tab.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/sections" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/sections"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/sections',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/sections'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 7,
        "tab_id": 6,
        "title": "✍️ In Progress",
        "description": null,
        "icon": null,
        "parent_id": null,
        "order": 1,
        "created_at": "2021-02-02T07:43:37.000000Z",
        "updated_at": "2024-04-24T09:23:50.000000Z",
        "is_hidden_for_users": 0,
        "color": null
    }
}

Request   

GET api/v1/sections

Get Child Sections

requires authentication

Retrieves all child sections for a given parent section.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/sections/12/children" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/sections/12/children"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/sections/12/children',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/sections/12/children'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "title": "Child Section 1",
            "description": "This is a child section",
            "icon": "folder",
            "parent_id": 5,
            "order": 1
        },
        {
            "id": 2,
            "title": "Child Section 2",
            "description": "Another child section",
            "icon": "file",
            "parent_id": 5,
            "order": 2
        }
    ]
}

Request   

GET api/v1/sections/{parentId}/children

URL Parameters

parentId  integer  

Statuses

Statuses can be used to track the status of posts. Each post gets one status.

List statuses

requires authentication

Lists all statuses.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/statuses',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/statuses'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "name": "Gathering votes",
            "color": "#DCD9F8",
            "order": 0,
            "tab_id": 1,
            "tab_name": "Wish list",
            "text_color": "#464362"
        },
        {
            "id": 1,
            "name": "Gathering votes",
            "color": "#DCD9F8",
            "order": 0,
            "tab_id": 1,
            "tab_name": "Wish list",
            "text_color": "#464362"
        }
    ]
}

Request   

GET api/v1/statuses

Create status

requires authentication

Creates a new status.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"color\": \"#UAMJLL$\\/m\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "color": "#UAMJLL$\/m"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/statuses',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'color' => '#UAMJLL$/m',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/statuses'
payload = {
    "color": "#UAMJLL$\/m"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "Gathering votes",
        "color": "#DCD9F8",
        "order": 0,
        "tab_id": 1,
        "tab_name": "Wish list",
        "text_color": "#464362"
    }
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "name": [
     "The name has already been taken."
 ]
}

Request   

POST api/v1/statuses

Body Parameters

name  string optional  

color  string optional  

The value format is invalid.

tab_id  string optional  

Update status

requires authentication

Updates the details of a status.

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/statuses/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"color\": \"#tauLdr$\\/m\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/statuses/9"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "color": "#tauLdr$\/m"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/statuses/9',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'color' => '#tauLdr$/m',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/statuses/9'
payload = {
    "color": "#tauLdr$\/m"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "Gathering votes",
        "color": "#DCD9F8",
        "order": 0,
        "tab_id": 1,
        "tab_name": "Wish list",
        "text_color": "#464362"
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Status] ..."
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "name": [
     "The name has already been taken."
 ]
}

Request   

PUT api/v1/statuses/{id}

URL Parameters

id  integer  

The ID of the status.

Body Parameters

name  string optional  

color  string  

The value format is invalid.

tab_id  string optional  

Delete status

requires authentication

Deletes a specified status.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/statuses/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/statuses/16"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/statuses/16',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/statuses/16'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\Status] ..."
}

Request   

DELETE api/v1/statuses/{id}

URL Parameters

id  integer  

The ID of the status.

Tabs

API endpoints for managing tabs.

Get tab

requires authentication

Retrieves the details of a specific tab by its slug.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/tabs/0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/tabs/0"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/tabs/0',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/tabs/0'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "General",
        "slug": "general",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2023-01-01T00:00:00Z"
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Tab] general"
}

Request   

GET api/v1/tabs/{key}

URL Parameters

key  integer  

slug  string  

The slug of the tab.

List tabs

requires authentication

Retrieves a collection of all tabs.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/tabs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/tabs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/tabs',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/tabs'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "name": "General",
            "slug": "general",
            "created_at": "2023-01-01T00:00:00Z",
            "updated_at": "2023-01-01T00:00:00Z"
        },
        {
            "id": 2,
            "name": "Support",
            "slug": "support",
            "created_at": "2023-01-02T00:00:00Z",
            "updated_at": "2023-01-02T00:00:00Z"
        }
    ]
}

Request   

GET api/v1/tabs

Tags

Tags can be used to label and categorize posts. Tags are not visible for your users. Posts can have multiple tags.

List tags

requires authentication

Lists all tags of your portal.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/tags',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/tags'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": "0026eeb9-df3b-42ea-9f90-d1716226f89f",
            "portal_id": 3414,
            "tag": "editor",
            "created_at": "2024-09-12T09:20:10.000000Z",
            "updated_at": "2024-09-12T09:20:10.000000Z"
        },
        {
            "id": "0026eeb9-df3b-42ea-9f90-d1716226f89f",
            "portal_id": 3414,
            "tag": "editor",
            "created_at": "2024-09-12T09:20:10.000000Z",
            "updated_at": "2024-09-12T09:20:10.000000Z"
        }
    ]
}

Request   

GET api/v1/tags

Create tag

requires authentication

Creates a new tag in your portal.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/tags',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/tags'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": "0026eeb9-df3b-42ea-9f90-d1716226f89f",
        "portal_id": 3414,
        "tag": "editor",
        "created_at": "2024-09-12T09:20:10.000000Z",
        "updated_at": "2024-09-12T09:20:10.000000Z"
    }
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "tag": [
     "The tag has already been taken."
 ]
}

Request   

POST api/v1/tags

Body Parameters

tag  string optional  

Update tag

requires authentication

Updates the details of a tag.

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/tags/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/tags/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/tags/6',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/tags/6'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": "0026eeb9-df3b-42ea-9f90-d1716226f89f",
        "portal_id": 3414,
        "tag": "editor",
        "created_at": "2024-09-12T09:20:10.000000Z",
        "updated_at": "2024-09-12T09:20:10.000000Z"
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Tag] ..."
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "tag": [
     "The tag has already been taken."
 ]
}

Request   

PUT api/v1/tags/{id}

URL Parameters

id  integer  

The ID of the tag.

Body Parameters

tag  string optional  

Delete tag

requires authentication

Deletes a specified tag.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/tags/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/tags/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/tags/13',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/tags/13'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\Tag] ..."
}

Request   

DELETE api/v1/tags/{id}

URL Parameters

id  integer  

The ID of the tag.

Users

Users can create posts, votes, and comments. You can create and manage users from the API.

Find by email

requires authentication

Retrieves the details of a specified user by email.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/users/find_by_email" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"tybvbltnqulzvykdvbhrlaghlnqzygpvexnkhkbxnlfafxgkrnnvklzlyabrirqldqoxheaggkmkqbeznpjpep\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/users/find_by_email"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "tybvbltnqulzvykdvbhrlaghlnqzygpvexnkhkbxnlfafxgkrnnvklzlyabrirqldqoxheaggkmkqbeznpjpep"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/users/find_by_email',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'tybvbltnqulzvykdvbhrlaghlnqzygpvexnkhkbxnlfafxgkrnnvklzlyabrirqldqoxheaggkmkqbeznpjpep',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/users/find_by_email'
payload = {
    "email": "tybvbltnqulzvykdvbhrlaghlnqzygpvexnkhkbxnlfafxgkrnnvklzlyabrirqldqoxheaggkmkqbeznpjpep"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": "02c4e10b-2b54-4389-9198-831697392470",
        "name": "Rhett",
        "email": "johnston.bernita@example.net",
        "role": "member",
        "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
        "avatar_small_url": "https://www.gravatar.com/avatar/6b63819740a1eafa73357f316c648d61?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Rhett/60/97C1A9/012b13",
        "counter_votes": 0,
        "counter_comments": 0,
        "counter_posts": 0,
        "counter_comment_votes": 0,
        "created_at": "2024-11-20T10:19:47.000000Z",
        "is_blocked": null,
        "verified": null,
        "admin_accepted": null,
        "sso_uid": null,
        "sso_avatar_url": null,
        "company": null,
        "segment_1": null,
        "segment_2": null,
        "segment_3": null,
        "segment_4": null,
        "segment_5": null,
        "segment_6": null,
        "segment_7": null,
        "segment_8": null,
        "segment_9": null,
        "segment_10": null,
        "segment_mrr": null,
        "segment_arr": null,
        "segment_ltv": null,
        "email_unsubscribed_at": null
    }
}

Example response (404):


{
    "message": "User not found"
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "role": [
     "The email must be a valid email address."
 ]
}

Request   

GET api/v1/users/find_by_email

Body Parameters

email  string  

The user's email. Must be a valid email address. Must not be greater than 191 characters.

List users

requires authentication

Lists all users of your portal.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 48,
    \"skip\": 17
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": 48,
    "skip": 17
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'limit' => 48,
            'skip' => 17,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/users'
payload = {
    "limit": 48,
    "skip": 17
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": "9397ec67-2b37-4623-8423-a6b26250832d",
            "name": "Lawson",
            "email": "keebler.zaria@example.org",
            "role": "member",
            "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
            "avatar_small_url": "https://www.gravatar.com/avatar/2bc0e182112cde61b84d4b15e4ef6e7a?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Lawson/60/ECEAE4/56544e",
            "counter_votes": 0,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0,
            "created_at": "2024-11-20T10:19:47.000000Z",
            "is_blocked": null,
            "verified": null,
            "admin_accepted": null,
            "sso_uid": null,
            "sso_avatar_url": null,
            "company": null,
            "segment_1": null,
            "segment_2": null,
            "segment_3": null,
            "segment_4": null,
            "segment_5": null,
            "segment_6": null,
            "segment_7": null,
            "segment_8": null,
            "segment_9": null,
            "segment_10": null,
            "segment_mrr": null,
            "segment_arr": null,
            "segment_ltv": null,
            "email_unsubscribed_at": null
        },
        {
            "id": "74c32ded-9789-4817-9b0c-34c1a8752160",
            "name": "Angus",
            "email": "mveum@example.net",
            "role": "member",
            "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
            "avatar_small_url": "https://www.gravatar.com/avatar/1e60a6ad5a58c46b8130fed9142a6a84?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Angus/60/FFD8BE/694228",
            "counter_votes": 0,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0,
            "created_at": "2024-11-20T10:19:47.000000Z",
            "is_blocked": null,
            "verified": null,
            "admin_accepted": null,
            "sso_uid": null,
            "sso_avatar_url": null,
            "company": null,
            "segment_1": null,
            "segment_2": null,
            "segment_3": null,
            "segment_4": null,
            "segment_5": null,
            "segment_6": null,
            "segment_7": null,
            "segment_8": null,
            "segment_9": null,
            "segment_10": null,
            "segment_mrr": null,
            "segment_arr": null,
            "segment_ltv": null,
            "email_unsubscribed_at": null
        }
    ]
}

Request   

GET api/v1/users

Body Parameters

limit  integer optional  

A limit on the number of posts to be returned. Limit can range between 1 and 100, and the default is 10. Must be at least 1. Must not be greater than 100.

skip  integer optional  

The number of users you'd like to skip before starting to fetch. Defaults to 0 if not specified.

Create user

requires authentication

Creates a new user in your portal. You can either provide a password, or you can invite the user.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"duwhyp\",
    \"role\": \"member\",
    \"name\": \"oqaighxfdumddgdhmbzhqsycizdguwumowzrxoztigxvpfypeau\",
    \"invitation_message\": \"ccophhznplmbhjyfrksttgwtndnfnobcqcljjlhrpankyvtfkcxfjkhgpmkfjguyuigskcaqydtlqmpcnglmolfhctgtoadhtcmkbllvdkahfayqavatqaqzjcwscbtiaurwzondyfpawvtmwzvyxafirfcdpcxuvgathuxbrjnytw\",
    \"password\": \"ztlkokq\",
    \"created_at\": \"2024-11-20T10:19:47\",
    \"is_blocked\": \"0\",
    \"verified\": \"true\",
    \"admin_accepted\": \"false\",
    \"sso_uid\": \"wvsyniiqlpuyxonrpvjutjqdmboncgqgwivjtgvicvfumkqdcpwhbikbyctdxlapsumbxvixmlexziswx\",
    \"sso_avatar_url\": \"kjpjbfjrfjkmqjkoit\",
    \"company\": \"zdtipdemzcxnqdrffwtyqrxnquzjnxmijtqyjuvhsozhwxncq\",
    \"segment_1\": \"snytzljqbuusdqnvpjybhjhrfrbkubsueacouddxzadpnwjcmfvdrgxldndvpcwxmyfgrktflqnikhvzhrsyqvsmgvejidrsfdyocwchelygiadxjmcivukvrkbgmibbflnxuwjdxwvtrshmjzqpdlirgegnwa\",
    \"segment_2\": \"aiignhizvfzgndjxwolreutjdsydsauushwqxgxmfdcrklgqlmzzfydmpayoezrljcbueuucnxrdsmaqsapmkjkhvhuhjoqnhgxqgnkwlzbhshopljnfhkgbwuvtwmdsdfjcmlnqbowschrvvda\",
    \"segment_3\": \"xkdnwyjerykjhlyoejuyeolsyajvsfjoclnacfefmgvtnxefethxxiyhrmbasztglgxxwcpyxchzozueutkpkkdcgmaudiarsyzzenazuooyeynwevxcwylrsueocfcrjuktmboxpmssuvfkizaukjwzdhphyl\",
    \"segment_4\": \"nlamoaccnuymjcyczxisosyersnfbxknqwzvejqotctgjnkepbqiodehfgqhudvcajshitrznundrkbzkflykdrgkvnpwjplalgbogduzjoatsxbyaushhskgkypcnoommrukuzbhwfnjaoqutoyntwoqafimguywrsxyazubuqktpqzctfemavsdvkpetlvdyeckrykwhspourawssdissronceekzchtyqpphlqdnic\",
    \"segment_5\": \"faozengfnqgloopslvwepieogyrfawubcvxqjhuwqysoyphcrsbyopmeciqolykqypbjsotjxpyexlyyxsjqiwsrgrvgvaitvarmazhlmqosxnczzjrmkndbwwlehhyjrmxcspodpczsbjatvewyvilgialrnwssyo\",
    \"segment_6\": \"xvvgelfugfbnhqekvkpnkxxxqdbrcoeouinmyvaguamjtfignrusiatadzvqldgcokkeehxslmynvklkepeebhatrztuhovqofvqtmrreieyjfpkautqiqrsgbtwewuhavkbzvrrcaeaqtchprxnnghveobtucfwriifxsjrdyuqilppnndizucbscpthyqqjnhtuffdpmjdfiltlpunctiecxzvwbpemuytrgqql\",
    \"segment_7\": \"gulmqinyfwqvxzgnxwugbbpyssghbnfkzzxdvnhaqnpkzzabapzxgsghgwmdaqtcvcpsclejtzlvehmlgqnhqqgnicpfeioyoyvtxktrtmelcnquykktclmaofzdzdpdvhsikymljndrwshfcbkqneibxonbzihnfozrnvoinxttlcsunfnaofsnuhcwkzgdhcyharwbzebtvzpjdeultpfuaeist\",
    \"segment_8\": \"qamfvwpepjsegizfwyqqamrolkabxixxzmumcplqsfxrtybswfsthtlttdnyfxanihznf\",
    \"segment_9\": \"nusjeoqjgvdtpvpvhqxtgjvdezusvhtvafihgzosauldgsdcyzhrozactvstezmrankdlzzchfnrtplhdamnvphcnyfazadxazmealznfuffvykznsbgukxrkxlfnoehhhajxwdbhqoehxhjkmmqvzirykorjmutooxnsukllgbinhyyybdgnbskzjiqzuomjlngcodwdytcrcspgxmlegqnkzgdfwkwhyuckkaqjhmrbouh\",
    \"segment_10\": \"spcjchkv\",
    \"segment_mrr\": 0,
    \"segment_arr\": 38999.838239773,
    \"segment_ltv\": 307199727.669,
    \"email_unsubscribed_at\": \"2024-11-20T10:19:47\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "duwhyp",
    "role": "member",
    "name": "oqaighxfdumddgdhmbzhqsycizdguwumowzrxoztigxvpfypeau",
    "invitation_message": "ccophhznplmbhjyfrksttgwtndnfnobcqcljjlhrpankyvtfkcxfjkhgpmkfjguyuigskcaqydtlqmpcnglmolfhctgtoadhtcmkbllvdkahfayqavatqaqzjcwscbtiaurwzondyfpawvtmwzvyxafirfcdpcxuvgathuxbrjnytw",
    "password": "ztlkokq",
    "created_at": "2024-11-20T10:19:47",
    "is_blocked": "0",
    "verified": "true",
    "admin_accepted": "false",
    "sso_uid": "wvsyniiqlpuyxonrpvjutjqdmboncgqgwivjtgvicvfumkqdcpwhbikbyctdxlapsumbxvixmlexziswx",
    "sso_avatar_url": "kjpjbfjrfjkmqjkoit",
    "company": "zdtipdemzcxnqdrffwtyqrxnquzjnxmijtqyjuvhsozhwxncq",
    "segment_1": "snytzljqbuusdqnvpjybhjhrfrbkubsueacouddxzadpnwjcmfvdrgxldndvpcwxmyfgrktflqnikhvzhrsyqvsmgvejidrsfdyocwchelygiadxjmcivukvrkbgmibbflnxuwjdxwvtrshmjzqpdlirgegnwa",
    "segment_2": "aiignhizvfzgndjxwolreutjdsydsauushwqxgxmfdcrklgqlmzzfydmpayoezrljcbueuucnxrdsmaqsapmkjkhvhuhjoqnhgxqgnkwlzbhshopljnfhkgbwuvtwmdsdfjcmlnqbowschrvvda",
    "segment_3": "xkdnwyjerykjhlyoejuyeolsyajvsfjoclnacfefmgvtnxefethxxiyhrmbasztglgxxwcpyxchzozueutkpkkdcgmaudiarsyzzenazuooyeynwevxcwylrsueocfcrjuktmboxpmssuvfkizaukjwzdhphyl",
    "segment_4": "nlamoaccnuymjcyczxisosyersnfbxknqwzvejqotctgjnkepbqiodehfgqhudvcajshitrznundrkbzkflykdrgkvnpwjplalgbogduzjoatsxbyaushhskgkypcnoommrukuzbhwfnjaoqutoyntwoqafimguywrsxyazubuqktpqzctfemavsdvkpetlvdyeckrykwhspourawssdissronceekzchtyqpphlqdnic",
    "segment_5": "faozengfnqgloopslvwepieogyrfawubcvxqjhuwqysoyphcrsbyopmeciqolykqypbjsotjxpyexlyyxsjqiwsrgrvgvaitvarmazhlmqosxnczzjrmkndbwwlehhyjrmxcspodpczsbjatvewyvilgialrnwssyo",
    "segment_6": "xvvgelfugfbnhqekvkpnkxxxqdbrcoeouinmyvaguamjtfignrusiatadzvqldgcokkeehxslmynvklkepeebhatrztuhovqofvqtmrreieyjfpkautqiqrsgbtwewuhavkbzvrrcaeaqtchprxnnghveobtucfwriifxsjrdyuqilppnndizucbscpthyqqjnhtuffdpmjdfiltlpunctiecxzvwbpemuytrgqql",
    "segment_7": "gulmqinyfwqvxzgnxwugbbpyssghbnfkzzxdvnhaqnpkzzabapzxgsghgwmdaqtcvcpsclejtzlvehmlgqnhqqgnicpfeioyoyvtxktrtmelcnquykktclmaofzdzdpdvhsikymljndrwshfcbkqneibxonbzihnfozrnvoinxttlcsunfnaofsnuhcwkzgdhcyharwbzebtvzpjdeultpfuaeist",
    "segment_8": "qamfvwpepjsegizfwyqqamrolkabxixxzmumcplqsfxrtybswfsthtlttdnyfxanihznf",
    "segment_9": "nusjeoqjgvdtpvpvhqxtgjvdezusvhtvafihgzosauldgsdcyzhrozactvstezmrankdlzzchfnrtplhdamnvphcnyfazadxazmealznfuffvykznsbgukxrkxlfnoehhhajxwdbhqoehxhjkmmqvzirykorjmutooxnsukllgbinhyyybdgnbskzjiqzuomjlngcodwdytcrcspgxmlegqnkzgdfwkwhyuckkaqjhmrbouh",
    "segment_10": "spcjchkv",
    "segment_mrr": 0,
    "segment_arr": 38999.838239773,
    "segment_ltv": 307199727.669,
    "email_unsubscribed_at": "2024-11-20T10:19:47"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'duwhyp',
            'role' => 'member',
            'name' => 'oqaighxfdumddgdhmbzhqsycizdguwumowzrxoztigxvpfypeau',
            'invitation_message' => 'ccophhznplmbhjyfrksttgwtndnfnobcqcljjlhrpankyvtfkcxfjkhgpmkfjguyuigskcaqydtlqmpcnglmolfhctgtoadhtcmkbllvdkahfayqavatqaqzjcwscbtiaurwzondyfpawvtmwzvyxafirfcdpcxuvgathuxbrjnytw',
            'password' => 'ztlkokq',
            'created_at' => '2024-11-20T10:19:47',
            'is_blocked' => '0',
            'verified' => 'true',
            'admin_accepted' => 'false',
            'sso_uid' => 'wvsyniiqlpuyxonrpvjutjqdmboncgqgwivjtgvicvfumkqdcpwhbikbyctdxlapsumbxvixmlexziswx',
            'sso_avatar_url' => 'kjpjbfjrfjkmqjkoit',
            'company' => 'zdtipdemzcxnqdrffwtyqrxnquzjnxmijtqyjuvhsozhwxncq',
            'segment_1' => 'snytzljqbuusdqnvpjybhjhrfrbkubsueacouddxzadpnwjcmfvdrgxldndvpcwxmyfgrktflqnikhvzhrsyqvsmgvejidrsfdyocwchelygiadxjmcivukvrkbgmibbflnxuwjdxwvtrshmjzqpdlirgegnwa',
            'segment_2' => 'aiignhizvfzgndjxwolreutjdsydsauushwqxgxmfdcrklgqlmzzfydmpayoezrljcbueuucnxrdsmaqsapmkjkhvhuhjoqnhgxqgnkwlzbhshopljnfhkgbwuvtwmdsdfjcmlnqbowschrvvda',
            'segment_3' => 'xkdnwyjerykjhlyoejuyeolsyajvsfjoclnacfefmgvtnxefethxxiyhrmbasztglgxxwcpyxchzozueutkpkkdcgmaudiarsyzzenazuooyeynwevxcwylrsueocfcrjuktmboxpmssuvfkizaukjwzdhphyl',
            'segment_4' => 'nlamoaccnuymjcyczxisosyersnfbxknqwzvejqotctgjnkepbqiodehfgqhudvcajshitrznundrkbzkflykdrgkvnpwjplalgbogduzjoatsxbyaushhskgkypcnoommrukuzbhwfnjaoqutoyntwoqafimguywrsxyazubuqktpqzctfemavsdvkpetlvdyeckrykwhspourawssdissronceekzchtyqpphlqdnic',
            'segment_5' => 'faozengfnqgloopslvwepieogyrfawubcvxqjhuwqysoyphcrsbyopmeciqolykqypbjsotjxpyexlyyxsjqiwsrgrvgvaitvarmazhlmqosxnczzjrmkndbwwlehhyjrmxcspodpczsbjatvewyvilgialrnwssyo',
            'segment_6' => 'xvvgelfugfbnhqekvkpnkxxxqdbrcoeouinmyvaguamjtfignrusiatadzvqldgcokkeehxslmynvklkepeebhatrztuhovqofvqtmrreieyjfpkautqiqrsgbtwewuhavkbzvrrcaeaqtchprxnnghveobtucfwriifxsjrdyuqilppnndizucbscpthyqqjnhtuffdpmjdfiltlpunctiecxzvwbpemuytrgqql',
            'segment_7' => 'gulmqinyfwqvxzgnxwugbbpyssghbnfkzzxdvnhaqnpkzzabapzxgsghgwmdaqtcvcpsclejtzlvehmlgqnhqqgnicpfeioyoyvtxktrtmelcnquykktclmaofzdzdpdvhsikymljndrwshfcbkqneibxonbzihnfozrnvoinxttlcsunfnaofsnuhcwkzgdhcyharwbzebtvzpjdeultpfuaeist',
            'segment_8' => 'qamfvwpepjsegizfwyqqamrolkabxixxzmumcplqsfxrtybswfsthtlttdnyfxanihznf',
            'segment_9' => 'nusjeoqjgvdtpvpvhqxtgjvdezusvhtvafihgzosauldgsdcyzhrozactvstezmrankdlzzchfnrtplhdamnvphcnyfazadxazmealznfuffvykznsbgukxrkxlfnoehhhajxwdbhqoehxhjkmmqvzirykorjmutooxnsukllgbinhyyybdgnbskzjiqzuomjlngcodwdytcrcspgxmlegqnkzgdfwkwhyuckkaqjhmrbouh',
            'segment_10' => 'spcjchkv',
            'segment_mrr' => 0.0,
            'segment_arr' => 38999.838239773,
            'segment_ltv' => 307199727.669,
            'email_unsubscribed_at' => '2024-11-20T10:19:47',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/users'
payload = {
    "email": "duwhyp",
    "role": "member",
    "name": "oqaighxfdumddgdhmbzhqsycizdguwumowzrxoztigxvpfypeau",
    "invitation_message": "ccophhznplmbhjyfrksttgwtndnfnobcqcljjlhrpankyvtfkcxfjkhgpmkfjguyuigskcaqydtlqmpcnglmolfhctgtoadhtcmkbllvdkahfayqavatqaqzjcwscbtiaurwzondyfpawvtmwzvyxafirfcdpcxuvgathuxbrjnytw",
    "password": "ztlkokq",
    "created_at": "2024-11-20T10:19:47",
    "is_blocked": "0",
    "verified": "true",
    "admin_accepted": "false",
    "sso_uid": "wvsyniiqlpuyxonrpvjutjqdmboncgqgwivjtgvicvfumkqdcpwhbikbyctdxlapsumbxvixmlexziswx",
    "sso_avatar_url": "kjpjbfjrfjkmqjkoit",
    "company": "zdtipdemzcxnqdrffwtyqrxnquzjnxmijtqyjuvhsozhwxncq",
    "segment_1": "snytzljqbuusdqnvpjybhjhrfrbkubsueacouddxzadpnwjcmfvdrgxldndvpcwxmyfgrktflqnikhvzhrsyqvsmgvejidrsfdyocwchelygiadxjmcivukvrkbgmibbflnxuwjdxwvtrshmjzqpdlirgegnwa",
    "segment_2": "aiignhizvfzgndjxwolreutjdsydsauushwqxgxmfdcrklgqlmzzfydmpayoezrljcbueuucnxrdsmaqsapmkjkhvhuhjoqnhgxqgnkwlzbhshopljnfhkgbwuvtwmdsdfjcmlnqbowschrvvda",
    "segment_3": "xkdnwyjerykjhlyoejuyeolsyajvsfjoclnacfefmgvtnxefethxxiyhrmbasztglgxxwcpyxchzozueutkpkkdcgmaudiarsyzzenazuooyeynwevxcwylrsueocfcrjuktmboxpmssuvfkizaukjwzdhphyl",
    "segment_4": "nlamoaccnuymjcyczxisosyersnfbxknqwzvejqotctgjnkepbqiodehfgqhudvcajshitrznundrkbzkflykdrgkvnpwjplalgbogduzjoatsxbyaushhskgkypcnoommrukuzbhwfnjaoqutoyntwoqafimguywrsxyazubuqktpqzctfemavsdvkpetlvdyeckrykwhspourawssdissronceekzchtyqpphlqdnic",
    "segment_5": "faozengfnqgloopslvwepieogyrfawubcvxqjhuwqysoyphcrsbyopmeciqolykqypbjsotjxpyexlyyxsjqiwsrgrvgvaitvarmazhlmqosxnczzjrmkndbwwlehhyjrmxcspodpczsbjatvewyvilgialrnwssyo",
    "segment_6": "xvvgelfugfbnhqekvkpnkxxxqdbrcoeouinmyvaguamjtfignrusiatadzvqldgcokkeehxslmynvklkepeebhatrztuhovqofvqtmrreieyjfpkautqiqrsgbtwewuhavkbzvrrcaeaqtchprxnnghveobtucfwriifxsjrdyuqilppnndizucbscpthyqqjnhtuffdpmjdfiltlpunctiecxzvwbpemuytrgqql",
    "segment_7": "gulmqinyfwqvxzgnxwugbbpyssghbnfkzzxdvnhaqnpkzzabapzxgsghgwmdaqtcvcpsclejtzlvehmlgqnhqqgnicpfeioyoyvtxktrtmelcnquykktclmaofzdzdpdvhsikymljndrwshfcbkqneibxonbzihnfozrnvoinxttlcsunfnaofsnuhcwkzgdhcyharwbzebtvzpjdeultpfuaeist",
    "segment_8": "qamfvwpepjsegizfwyqqamrolkabxixxzmumcplqsfxrtybswfsthtlttdnyfxanihznf",
    "segment_9": "nusjeoqjgvdtpvpvhqxtgjvdezusvhtvafihgzosauldgsdcyzhrozactvstezmrankdlzzchfnrtplhdamnvphcnyfazadxazmealznfuffvykznsbgukxrkxlfnoehhhajxwdbhqoehxhjkmmqvzirykorjmutooxnsukllgbinhyyybdgnbskzjiqzuomjlngcodwdytcrcspgxmlegqnkzgdfwkwhyuckkaqjhmrbouh",
    "segment_10": "spcjchkv",
    "segment_mrr": 0,
    "segment_arr": 38999.838239773,
    "segment_ltv": 307199727.669,
    "email_unsubscribed_at": "2024-11-20T10:19:47"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": "b1f4d93b-257d-40f6-90fa-f1d0d5441bcb",
        "name": "Gregg",
        "email": "xmraz@example.net",
        "role": "member",
        "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
        "avatar_small_url": "https://www.gravatar.com/avatar/ca5b840be59251dca92017cf1a277f1d?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Gregg/60/FFAEA5/69180f",
        "counter_votes": 0,
        "counter_comments": 0,
        "counter_posts": 0,
        "counter_comment_votes": 0,
        "created_at": "2024-11-20T10:19:47.000000Z",
        "is_blocked": null,
        "verified": null,
        "admin_accepted": null,
        "sso_uid": null,
        "sso_avatar_url": null,
        "company": null,
        "segment_1": null,
        "segment_2": null,
        "segment_3": null,
        "segment_4": null,
        "segment_5": null,
        "segment_6": null,
        "segment_7": null,
        "segment_8": null,
        "segment_9": null,
        "segment_10": null,
        "segment_mrr": null,
        "segment_arr": null,
        "segment_ltv": null,
        "email_unsubscribed_at": null
    }
}

Example response (422):


{
    "message": "User already exists"
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "role": [
     "The selected role is invalid."
 ]
}

Request   

POST api/v1/users

Body Parameters

email  string optional  

Must be a valid email address. Must not be greater than 191 characters.

role  string  

Must be one of admin or member.

name  string optional  

Name for the user. Omit or null to automatically determine a name based on the email. Must not be greater than 100 characters.

invitation_message  string optional  

You can provide a custom invitation message. Omit or null to use the default message. Must not be greater than 1000 characters.

skip_email  string optional  

Provide a value to skip sending an email. Omit or null to send invitation email.

password  string optional  

Provide a password to skip sending an invitation. Omit or null to use an invitation (for which an email can be sent or not). Must not be greater than 100 characters. Must be at least 8 characters.

created_at  string optional  

The creation date of the user. Defaults to current timestamp if not provided. Must be a valid date.

is_blocked  string optional  

Whether the user is blocked from accessing the portal. Must be one of true, false, 0, or 1.

verified  string optional  

Whether the user's email is verified. Must be one of true, false, 0, or 1.

admin_accepted  string optional  

Whether the user is accepted by an admin. Must be one of true, false, 0, or 1.

sso_uid  string optional  

The user's SSO unique identifier. Must not be greater than 255 characters.

sso_avatar_url  string optional  

The URL of the user's avatar from SSO provider. Must be a valid URL. Must not be greater than 255 characters.

company  string optional  

The user's company name. Must not be greater than 255 characters.

segment_1  string optional  

Custom segment fields for user categorization. Must not be greater than 255 characters.

segment_2  string optional  

Must not be greater than 255 characters.

segment_3  string optional  

Must not be greater than 255 characters.

segment_4  string optional  

Must not be greater than 255 characters.

segment_5  string optional  

Must not be greater than 255 characters.

segment_6  string optional  

Must not be greater than 255 characters.

segment_7  string optional  

Must not be greater than 255 characters.

segment_8  string optional  

Must not be greater than 255 characters.

segment_9  string optional  

Must not be greater than 255 characters.

segment_10  string optional  

Must not be greater than 255 characters.

segment_mrr  number optional  

Monthly Recurring Revenue for the user.

segment_arr  number optional  

Annual Recurring Revenue for the user.

segment_ltv  number optional  

Lifetime Value of the user.

email_unsubscribed_at  string optional  

The date when the user unsubscribed from emails. Must be a valid date.

Get user

requires authentication

Retrieves the details of a specified user.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": "d674bf35-374b-43b7-a3b3-8bf6d7a25387",
        "name": "Trystan",
        "email": "josefina.hane@example.org",
        "role": "member",
        "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
        "avatar_small_url": "https://www.gravatar.com/avatar/dc11752980e145fd3b8327ffb370a6b8?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Trystan/60/A2E1DB/0c4b45",
        "counter_votes": 0,
        "counter_comments": 0,
        "counter_posts": 0,
        "counter_comment_votes": 0,
        "created_at": "2024-11-20T10:19:47.000000Z",
        "is_blocked": null,
        "verified": null,
        "admin_accepted": null,
        "sso_uid": null,
        "sso_avatar_url": null,
        "company": null,
        "segment_1": null,
        "segment_2": null,
        "segment_3": null,
        "segment_4": null,
        "segment_5": null,
        "segment_6": null,
        "segment_7": null,
        "segment_8": null,
        "segment_9": null,
        "segment_10": null,
        "segment_mrr": null,
        "segment_arr": null,
        "segment_ltv": null,
        "email_unsubscribed_at": null
    }
}

Example response (404):


{
    "message": "No query results for model [App\\User] ..."
}

Request   

GET api/v1/users/{id}

URL Parameters

id  string  

The ID of the user.

Update user

requires authentication

Updates the details of a specified user.

Example request:
curl --request PUT \
    "{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"claire.wyman@example.org\",
    \"role\": \"admin\",
    \"name\": \"iyggkiwgupclwxwyfpanilhrdostsgvplhzceuwiialuoyfpngugmygqqzpigzfklcjvscgteftmfpqpxq\",
    \"password\": \"kw\",
    \"created_at\": \"2024-11-20T10:19:47\",
    \"is_blocked\": \"0\",
    \"verified\": \"true\",
    \"admin_accepted\": \"true\",
    \"sso_uid\": \"wedxgjcihjazwbrqtbnkgqgoizjblojdvlhfgipsimokznhpuugezjlisabytecrhsiluzkfshspsmkqtokadsftumuroqbgdqnbajswmxbywqxtyunlqtjqoffijuucixugxguuxuldiknajqttpqibzzairwkbaudeotkdmdaqdxuibjybzldbceffnwjjxmfsulowxlftjpwrhloennvx\",
    \"sso_avatar_url\": \"bpfpshkmwtertqtqohjmrlsfcqzfngubxzclpwgmfxuxwenxcjvzaxtz\",
    \"company\": \"uueeeyklonaeuhjmiiziplyenqjtbb\",
    \"segment_1\": \"sknoewhypkllefehiz\",
    \"segment_2\": \"uffscqjwpkfxqfrgtft\",
    \"segment_3\": \"jowyawdrrtvocownbfjpoizzlmsgbwyxemyhzpgeqvzxzoivysannndndyttrpgtccnatuabkyqmazvtabzgkvmmzvklfzoygoiiqpmeomvakbtyaeodsxikpfevsxsnprizkbxjolftsfxjcxboiraqdifpvsfcsuyvuplympvvoimscgzwatfpasjukldmjkfvcopyxbazjsgelxvvgwwargt\",
    \"segment_4\": \"nmrnjfugykbgolfxlwrrujyyyocrcypzryyvqeowetpjotavsmyhnhwzocquhtzzazyuemqadgzknlxrotcemsxslnffmuiwigpqayjnodvmhxnnlzagnvtptqjatlzxwwfupoewwodhfpftatoz\",
    \"segment_5\": \"bxqplndwkrkxwjdteoaxumizmzysxvdytwczgodgupblopjthebemvaqtxruzxjtdqmkpbixyyvxffjnrxuyhjhscanvphifjjuadbrrxkddsiipnutwvhjrlgelcbuclrzbckcohvkwotsifwkymykrgihajqjuxenysjp\",
    \"segment_6\": \"vqlbnoutvdzflcvoasbkekxegfrdyktdboupopigrptyiqngyvcjpmsvghrfmmpcfyndlqkpgcxssagteeaueargzvmqzpxnxfccwkgplcplajsuznuebkiextjztjstji\",
    \"segment_7\": \"sqzwqcttdttyxuxlzbwofstlwsjcxrejcvphmakrywwqbgaciahxoyrqgfkwygzubvhinbbooxwtfplziyikxnquljypwpizwqoccspjvhurybcbkppgrjyyanftwyzcdhatbkhizpbdjnmandhtompuwbkiwjztntkikagmnymjhtcpqtneidirlyxkzccharbvvufsviwxgfnjejdzylzxyrgakdbrvqrswfjmabwxkeiwrkqibzqfcbjkfcf\",
    \"segment_8\": \"rqgwuxsuyrhusjtgjdrnmikmbohsyhngqwhidqsmtvwtcecfdi\",
    \"segment_9\": \"pdpsgrleallnmqigywhnkfepkkhkavrrymeuqyzqhyzkvpvzbymclmrqklkjkrmnoytacqvvxkphpzbyipooqhhkttkhpzoawtuaxomgchacwofltvuftlzusyyhlhuhkdufkntmygcnytcbuhqlxekpdqdrztxdydymocxwfdeoubygwlbkfobbdhnsbsmdkdyxklxbfxtmedhbcpwkmwopr\",
    \"segment_10\": \"rbuypgvhplxryryxjbtcuyvnjhbsmhtrvllxkidttyogygzkrsjiulbyyuwuimidsldxnpagpokhq\",
    \"segment_mrr\": 10055.9,
    \"segment_arr\": 182932.711,
    \"segment_ltv\": 451548691.522161,
    \"email_unsubscribed_at\": \"2024-11-20T10:19:47\"
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "claire.wyman@example.org",
    "role": "admin",
    "name": "iyggkiwgupclwxwyfpanilhrdostsgvplhzceuwiialuoyfpngugmygqqzpigzfklcjvscgteftmfpqpxq",
    "password": "kw",
    "created_at": "2024-11-20T10:19:47",
    "is_blocked": "0",
    "verified": "true",
    "admin_accepted": "true",
    "sso_uid": "wedxgjcihjazwbrqtbnkgqgoizjblojdvlhfgipsimokznhpuugezjlisabytecrhsiluzkfshspsmkqtokadsftumuroqbgdqnbajswmxbywqxtyunlqtjqoffijuucixugxguuxuldiknajqttpqibzzairwkbaudeotkdmdaqdxuibjybzldbceffnwjjxmfsulowxlftjpwrhloennvx",
    "sso_avatar_url": "bpfpshkmwtertqtqohjmrlsfcqzfngubxzclpwgmfxuxwenxcjvzaxtz",
    "company": "uueeeyklonaeuhjmiiziplyenqjtbb",
    "segment_1": "sknoewhypkllefehiz",
    "segment_2": "uffscqjwpkfxqfrgtft",
    "segment_3": "jowyawdrrtvocownbfjpoizzlmsgbwyxemyhzpgeqvzxzoivysannndndyttrpgtccnatuabkyqmazvtabzgkvmmzvklfzoygoiiqpmeomvakbtyaeodsxikpfevsxsnprizkbxjolftsfxjcxboiraqdifpvsfcsuyvuplympvvoimscgzwatfpasjukldmjkfvcopyxbazjsgelxvvgwwargt",
    "segment_4": "nmrnjfugykbgolfxlwrrujyyyocrcypzryyvqeowetpjotavsmyhnhwzocquhtzzazyuemqadgzknlxrotcemsxslnffmuiwigpqayjnodvmhxnnlzagnvtptqjatlzxwwfupoewwodhfpftatoz",
    "segment_5": "bxqplndwkrkxwjdteoaxumizmzysxvdytwczgodgupblopjthebemvaqtxruzxjtdqmkpbixyyvxffjnrxuyhjhscanvphifjjuadbrrxkddsiipnutwvhjrlgelcbuclrzbckcohvkwotsifwkymykrgihajqjuxenysjp",
    "segment_6": "vqlbnoutvdzflcvoasbkekxegfrdyktdboupopigrptyiqngyvcjpmsvghrfmmpcfyndlqkpgcxssagteeaueargzvmqzpxnxfccwkgplcplajsuznuebkiextjztjstji",
    "segment_7": "sqzwqcttdttyxuxlzbwofstlwsjcxrejcvphmakrywwqbgaciahxoyrqgfkwygzubvhinbbooxwtfplziyikxnquljypwpizwqoccspjvhurybcbkppgrjyyanftwyzcdhatbkhizpbdjnmandhtompuwbkiwjztntkikagmnymjhtcpqtneidirlyxkzccharbvvufsviwxgfnjejdzylzxyrgakdbrvqrswfjmabwxkeiwrkqibzqfcbjkfcf",
    "segment_8": "rqgwuxsuyrhusjtgjdrnmikmbohsyhngqwhidqsmtvwtcecfdi",
    "segment_9": "pdpsgrleallnmqigywhnkfepkkhkavrrymeuqyzqhyzkvpvzbymclmrqklkjkrmnoytacqvvxkphpzbyipooqhhkttkhpzoawtuaxomgchacwofltvuftlzusyyhlhuhkdufkntmygcnytcbuhqlxekpdqdrztxdydymocxwfdeoubygwlbkfobbdhnsbsmdkdyxklxbfxtmedhbcpwkmwopr",
    "segment_10": "rbuypgvhplxryryxjbtcuyvnjhbsmhtrvllxkidttyogygzkrsjiulbyyuwuimidsldxnpagpokhq",
    "segment_mrr": 10055.9,
    "segment_arr": 182932.711,
    "segment_ltv": 451548691.522161,
    "email_unsubscribed_at": "2024-11-20T10:19:47"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    '{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'claire.wyman@example.org',
            'role' => 'admin',
            'name' => 'iyggkiwgupclwxwyfpanilhrdostsgvplhzceuwiialuoyfpngugmygqqzpigzfklcjvscgteftmfpqpxq',
            'password' => 'kw',
            'created_at' => '2024-11-20T10:19:47',
            'is_blocked' => '0',
            'verified' => 'true',
            'admin_accepted' => 'true',
            'sso_uid' => 'wedxgjcihjazwbrqtbnkgqgoizjblojdvlhfgipsimokznhpuugezjlisabytecrhsiluzkfshspsmkqtokadsftumuroqbgdqnbajswmxbywqxtyunlqtjqoffijuucixugxguuxuldiknajqttpqibzzairwkbaudeotkdmdaqdxuibjybzldbceffnwjjxmfsulowxlftjpwrhloennvx',
            'sso_avatar_url' => 'bpfpshkmwtertqtqohjmrlsfcqzfngubxzclpwgmfxuxwenxcjvzaxtz',
            'company' => 'uueeeyklonaeuhjmiiziplyenqjtbb',
            'segment_1' => 'sknoewhypkllefehiz',
            'segment_2' => 'uffscqjwpkfxqfrgtft',
            'segment_3' => 'jowyawdrrtvocownbfjpoizzlmsgbwyxemyhzpgeqvzxzoivysannndndyttrpgtccnatuabkyqmazvtabzgkvmmzvklfzoygoiiqpmeomvakbtyaeodsxikpfevsxsnprizkbxjolftsfxjcxboiraqdifpvsfcsuyvuplympvvoimscgzwatfpasjukldmjkfvcopyxbazjsgelxvvgwwargt',
            'segment_4' => 'nmrnjfugykbgolfxlwrrujyyyocrcypzryyvqeowetpjotavsmyhnhwzocquhtzzazyuemqadgzknlxrotcemsxslnffmuiwigpqayjnodvmhxnnlzagnvtptqjatlzxwwfupoewwodhfpftatoz',
            'segment_5' => 'bxqplndwkrkxwjdteoaxumizmzysxvdytwczgodgupblopjthebemvaqtxruzxjtdqmkpbixyyvxffjnrxuyhjhscanvphifjjuadbrrxkddsiipnutwvhjrlgelcbuclrzbckcohvkwotsifwkymykrgihajqjuxenysjp',
            'segment_6' => 'vqlbnoutvdzflcvoasbkekxegfrdyktdboupopigrptyiqngyvcjpmsvghrfmmpcfyndlqkpgcxssagteeaueargzvmqzpxnxfccwkgplcplajsuznuebkiextjztjstji',
            'segment_7' => 'sqzwqcttdttyxuxlzbwofstlwsjcxrejcvphmakrywwqbgaciahxoyrqgfkwygzubvhinbbooxwtfplziyikxnquljypwpizwqoccspjvhurybcbkppgrjyyanftwyzcdhatbkhizpbdjnmandhtompuwbkiwjztntkikagmnymjhtcpqtneidirlyxkzccharbvvufsviwxgfnjejdzylzxyrgakdbrvqrswfjmabwxkeiwrkqibzqfcbjkfcf',
            'segment_8' => 'rqgwuxsuyrhusjtgjdrnmikmbohsyhngqwhidqsmtvwtcecfdi',
            'segment_9' => 'pdpsgrleallnmqigywhnkfepkkhkavrrymeuqyzqhyzkvpvzbymclmrqklkjkrmnoytacqvvxkphpzbyipooqhhkttkhpzoawtuaxomgchacwofltvuftlzusyyhlhuhkdufkntmygcnytcbuhqlxekpdqdrztxdydymocxwfdeoubygwlbkfobbdhnsbsmdkdyxklxbfxtmedhbcpwkmwopr',
            'segment_10' => 'rbuypgvhplxryryxjbtcuyvnjhbsmhtrvllxkidttyogygzkrsjiulbyyuwuimidsldxnpagpokhq',
            'segment_mrr' => 10055.9,
            'segment_arr' => 182932.711,
            'segment_ltv' => 451548691.522161,
            'email_unsubscribed_at' => '2024-11-20T10:19:47',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88'
payload = {
    "email": "claire.wyman@example.org",
    "role": "admin",
    "name": "iyggkiwgupclwxwyfpanilhrdostsgvplhzceuwiialuoyfpngugmygqqzpigzfklcjvscgteftmfpqpxq",
    "password": "kw",
    "created_at": "2024-11-20T10:19:47",
    "is_blocked": "0",
    "verified": "true",
    "admin_accepted": "true",
    "sso_uid": "wedxgjcihjazwbrqtbnkgqgoizjblojdvlhfgipsimokznhpuugezjlisabytecrhsiluzkfshspsmkqtokadsftumuroqbgdqnbajswmxbywqxtyunlqtjqoffijuucixugxguuxuldiknajqttpqibzzairwkbaudeotkdmdaqdxuibjybzldbceffnwjjxmfsulowxlftjpwrhloennvx",
    "sso_avatar_url": "bpfpshkmwtertqtqohjmrlsfcqzfngubxzclpwgmfxuxwenxcjvzaxtz",
    "company": "uueeeyklonaeuhjmiiziplyenqjtbb",
    "segment_1": "sknoewhypkllefehiz",
    "segment_2": "uffscqjwpkfxqfrgtft",
    "segment_3": "jowyawdrrtvocownbfjpoizzlmsgbwyxemyhzpgeqvzxzoivysannndndyttrpgtccnatuabkyqmazvtabzgkvmmzvklfzoygoiiqpmeomvakbtyaeodsxikpfevsxsnprizkbxjolftsfxjcxboiraqdifpvsfcsuyvuplympvvoimscgzwatfpasjukldmjkfvcopyxbazjsgelxvvgwwargt",
    "segment_4": "nmrnjfugykbgolfxlwrrujyyyocrcypzryyvqeowetpjotavsmyhnhwzocquhtzzazyuemqadgzknlxrotcemsxslnffmuiwigpqayjnodvmhxnnlzagnvtptqjatlzxwwfupoewwodhfpftatoz",
    "segment_5": "bxqplndwkrkxwjdteoaxumizmzysxvdytwczgodgupblopjthebemvaqtxruzxjtdqmkpbixyyvxffjnrxuyhjhscanvphifjjuadbrrxkddsiipnutwvhjrlgelcbuclrzbckcohvkwotsifwkymykrgihajqjuxenysjp",
    "segment_6": "vqlbnoutvdzflcvoasbkekxegfrdyktdboupopigrptyiqngyvcjpmsvghrfmmpcfyndlqkpgcxssagteeaueargzvmqzpxnxfccwkgplcplajsuznuebkiextjztjstji",
    "segment_7": "sqzwqcttdttyxuxlzbwofstlwsjcxrejcvphmakrywwqbgaciahxoyrqgfkwygzubvhinbbooxwtfplziyikxnquljypwpizwqoccspjvhurybcbkppgrjyyanftwyzcdhatbkhizpbdjnmandhtompuwbkiwjztntkikagmnymjhtcpqtneidirlyxkzccharbvvufsviwxgfnjejdzylzxyrgakdbrvqrswfjmabwxkeiwrkqibzqfcbjkfcf",
    "segment_8": "rqgwuxsuyrhusjtgjdrnmikmbohsyhngqwhidqsmtvwtcecfdi",
    "segment_9": "pdpsgrleallnmqigywhnkfepkkhkavrrymeuqyzqhyzkvpvzbymclmrqklkjkrmnoytacqvvxkphpzbyipooqhhkttkhpzoawtuaxomgchacwofltvuftlzusyyhlhuhkdufkntmygcnytcbuhqlxekpdqdrztxdydymocxwfdeoubygwlbkfobbdhnsbsmdkdyxklxbfxtmedhbcpwkmwopr",
    "segment_10": "rbuypgvhplxryryxjbtcuyvnjhbsmhtrvllxkidttyogygzkrsjiulbyyuwuimidsldxnpagpokhq",
    "segment_mrr": 10055.9,
    "segment_arr": 182932.711,
    "segment_ltv": 451548691.522161,
    "email_unsubscribed_at": "2024-11-20T10:19:47"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": "6f9143a2-1c5f-49f7-8882-65fd4165a209",
        "name": "Owen",
        "email": "brent96@example.com",
        "role": "member",
        "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
        "avatar_small_url": "https://www.gravatar.com/avatar/0335c46c80bc4810f50f4d8098283689?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Owen/60/FFC8A2/69320c",
        "counter_votes": 0,
        "counter_comments": 0,
        "counter_posts": 0,
        "counter_comment_votes": 0,
        "created_at": "2024-11-20T10:19:47.000000Z",
        "is_blocked": null,
        "verified": null,
        "admin_accepted": null,
        "sso_uid": null,
        "sso_avatar_url": null,
        "company": null,
        "segment_1": null,
        "segment_2": null,
        "segment_3": null,
        "segment_4": null,
        "segment_5": null,
        "segment_6": null,
        "segment_7": null,
        "segment_8": null,
        "segment_9": null,
        "segment_10": null,
        "segment_mrr": null,
        "segment_arr": null,
        "segment_ltv": null,
        "email_unsubscribed_at": null
    }
}

Example response (404):


{
    "message": "No query results for model [App\\User] ..."
}

Example response (422):


{
 "message": "The given data was invalid.",
 "errors": {
 "role": [
     "The selected role is invalid."
 ]
}

Request   

PUT api/v1/users/{id}

PATCH api/v1/users/{id}

URL Parameters

id  string  

The ID of the user.

Body Parameters

email  string optional  

Make null or omit to keep current value. Must be unique in the portal. Must be a valid email address.

role  string optional  

Make null or omit to keep current value. Must be one of admin or member.

name  string optional  

Make null or omit to keep current value. Must not be greater than 100 characters.

password  string optional  

Make null or omit to keep current value. Must not be greater than 100 characters. Must be at least 8 characters.

created_at  string optional  

The creation date of the user. Must be a valid date.

is_blocked  string optional  

Whether the user is blocked from accessing the portal. Must be one of true, false, 0, or 1.

verified  string optional  

Whether the user's email is verified. Must be one of true, false, 0, or 1.

admin_accepted  string optional  

Whether the user is accepted by an admin. Must be one of true, false, 0, or 1.

sso_uid  string optional  

The user's SSO unique identifier. Must not be greater than 255 characters.

sso_avatar_url  string optional  

The URL of the user's avatar from SSO provider. Must be a valid URL. Must not be greater than 255 characters.

company  string optional  

The user's company name. Must not be greater than 255 characters.

segment_1  string optional  

Custom segment fields for user categorization. Must not be greater than 255 characters.

segment_2  string optional  

Must not be greater than 255 characters.

segment_3  string optional  

Must not be greater than 255 characters.

segment_4  string optional  

Must not be greater than 255 characters.

segment_5  string optional  

Must not be greater than 255 characters.

segment_6  string optional  

Must not be greater than 255 characters.

segment_7  string optional  

Must not be greater than 255 characters.

segment_8  string optional  

Must not be greater than 255 characters.

segment_9  string optional  

Must not be greater than 255 characters.

segment_10  string optional  

Must not be greater than 255 characters.

segment_mrr  number optional  

Monthly Recurring Revenue for the user.

segment_arr  number optional  

Annual Recurring Revenue for the user.

segment_ltv  number optional  

Lifetime Value of the user.

email_unsubscribed_at  string optional  

The date when the user unsubscribed from emails. Must be a valid date.

Delete user

requires authentication

Deletes a specified user.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"delete_all_data\": true
}"

const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "delete_all_data": true
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'delete_all_data' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/users/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88'
payload = {
    "delete_all_data": true
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\User] ..."
}

Request   

DELETE api/v1/users/{id}

URL Parameters

id  string  

The ID of the user.

Body Parameters

delete_all_data  boolean optional  

Set true or 1 to delete all data from this user. Otherwise, posts, comments, will remain with [User Deleted] as the username.

Votes

Manage votes on your posts.

List votes

requires authentication

Lists all votes of a post.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "created_at": "2020-06-09T14:40:38.000000Z",
            "voter": {
                "id": "2850e389-2827-4316-a50a-fcdcc6474b5d",
                "name": "Jordi",
                "email": "descubre@exploradoresdemartech.com",
                "role": "member",
                "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
                "avatar_small_url": "https://www.gravatar.com/avatar/72802d9f5cd0781807579a89a3947b75?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Jordi/60/CCE2CB/364c35",
                "counter_votes": 3,
                "counter_comments": 0,
                "counter_posts": 0,
                "counter_comment_votes": 0,
                "created_at": "2020-06-09T14:40:23.000000Z",
                "is_blocked": 0,
                "verified": false,
                "admin_accepted": 1,
                "sso_uid": null,
                "sso_avatar_url": null,
                "company": null,
                "segment_1": null,
                "segment_2": null,
                "segment_3": null,
                "segment_4": null,
                "segment_5": null,
                "segment_6": null,
                "segment_7": null,
                "segment_8": null,
                "segment_9": null,
                "segment_10": null,
                "segment_mrr": null,
                "segment_arr": null,
                "segment_ltv": null,
                "email_unsubscribed_at": null
            }
        },
        {
            "created_at": "2020-06-09T14:40:38.000000Z",
            "voter": {
                "id": "2850e389-2827-4316-a50a-fcdcc6474b5d",
                "name": "Jordi",
                "email": "descubre@exploradoresdemartech.com",
                "role": "member",
                "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
                "avatar_small_url": "https://www.gravatar.com/avatar/72802d9f5cd0781807579a89a3947b75?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Jordi/60/CCE2CB/364c35",
                "counter_votes": 3,
                "counter_comments": 0,
                "counter_posts": 0,
                "counter_comment_votes": 0,
                "created_at": "2020-06-09T14:40:23.000000Z",
                "is_blocked": 0,
                "verified": false,
                "admin_accepted": 1,
                "sso_uid": null,
                "sso_avatar_url": null,
                "company": null,
                "segment_1": null,
                "segment_2": null,
                "segment_3": null,
                "segment_4": null,
                "segment_5": null,
                "segment_6": null,
                "segment_7": null,
                "segment_8": null,
                "segment_9": null,
                "segment_10": null,
                "segment_mrr": null,
                "segment_arr": null,
                "segment_ltv": null,
                "email_unsubscribed_at": null
            }
        }
    ]
}

Request   

GET api/v1/posts/{key}/votes

URL Parameters

key  string  

The ID of the post.

Revoke vote

requires authentication

Revoke a user's vote for a post.

Example request:
curl --request DELETE \
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{}

Example response (404):


{
    "message": "No query results for model [App\\User] ..."
}

Example response (404):


{
    "message": "No query results for model [App\\Post] ..."
}

Example response (422):


{
    "message": "Post is not voteable."
}

Example response (422):


{
    "message": "User has not voted yet."
}

Request   

DELETE api/v1/posts/{key}/votes/{user}

URL Parameters

key  string  

The ID of the post.

user  string  

The ID of the user.

Vote

requires authentication

Add the vote of a user to a post.

Example request:
curl --request POST \
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/posts/0UFQQh/votes/8cbfbfd6-ecc3-4ec3-8b31-ea76b11c1f88'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "created_at": "2020-06-09T14:40:38.000000Z",
        "voter": {
            "id": "2850e389-2827-4316-a50a-fcdcc6474b5d",
            "name": "Jordi",
            "email": "descubre@exploradoresdemartech.com",
            "role": "member",
            "profile_url": "{YOUR-PORTAL-URL}/user/profile/123456",
            "avatar_small_url": "https://www.gravatar.com/avatar/72802d9f5cd0781807579a89a3947b75?s=60&d=https%3A%2F%2Fui-avatars.com%2Fapi%2F/Jordi/60/CCE2CB/364c35",
            "counter_votes": 3,
            "counter_comments": 0,
            "counter_posts": 0,
            "counter_comment_votes": 0,
            "created_at": "2020-06-09T14:40:23.000000Z",
            "is_blocked": 0,
            "verified": false,
            "admin_accepted": 1,
            "sso_uid": null,
            "sso_avatar_url": null,
            "company": null,
            "segment_1": null,
            "segment_2": null,
            "segment_3": null,
            "segment_4": null,
            "segment_5": null,
            "segment_6": null,
            "segment_7": null,
            "segment_8": null,
            "segment_9": null,
            "segment_10": null,
            "segment_mrr": null,
            "segment_arr": null,
            "segment_ltv": null,
            "email_unsubscribed_at": null
        }
    }
}

Example response (404):


{
    "message": "No query results for model [App\\User] ..."
}

Example response (404):


{
    "message": "No query results for model [App\\Post] ..."
}

Example response (422):


{
    "message": "Post is not voteable."
}

Example response (422):


{
    "message": "User has already voted for this post."
}

Request   

POST api/v1/posts/{key}/votes/{user}

URL Parameters

key  string  

The ID of the post.

user  string  

The ID of the user.

Widgets

API endpoints for managing widgets in your portal.

List widgets

requires authentication

Retrieves a collection of all widgets in your portal.

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/widgets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/widgets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/widgets',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/widgets'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": "widget1",
            "name": "Feedback Widget",
            "type": "feedback",
            "created_at": "2023-01-01T00:00:00Z",
            "updated_at": "2023-01-01T00:00:00Z"
        },
        {
            "id": "widget2",
            "name": "Survey Widget",
            "type": "survey",
            "created_at": "2023-01-02T00:00:00Z",
            "updated_at": "2023-01-02T00:00:00Z"
        }
    ]
}

Request   

GET api/v1/widgets

Get widget

requires authentication

Retrieves the details of a specific widget by its key (ID).

Example request:
curl --request GET \
    --get "{YOUR_PORTAL_URL}/api/v1/widgets/widget1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "{YOUR_PORTAL_URL}/api/v1/widgets/widget1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    '{YOUR_PORTAL_URL}/api/v1/widgets/widget1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = '{YOUR_PORTAL_URL}/api/v1/widgets/widget1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": "widget1",
        "name": "Feedback Widget",
        "type": "feedback",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2023-01-01T00:00:00Z"
    }
}

Example response (404):


{
    "message": "No query results for model [App\\Widget] widget1"
}

Request   

GET api/v1/widgets/{key}

URL Parameters

key  string  

The unique identifier of the widget.