Setup

List Topics

GET https://api.synthesio.com/v1/projects/{project_id}/setup/social/topics

Lists the topics in the social setup of the project.

Path parameters#

project_id string required

ID of the project

Responses#

Successful Response

application/json
topics array of object

List of topics in the social setup of the project. In case of two-level topic setup, these are the top-level topics.

topics[].id string
example"r03aptazwuxvkljkf84w"
topics[].name string
example"Food"
topics[].status string

Status of the topic:

  • draft: the topic has been modified but not processed yet
  • applied: the topic has been processed
  • to_delete: the topic has been removed but the removal has not been processed yet
Enum"draft""applied""to_delete"or any string (open enum)
example"applied"
topics[].color string

Hexadecimal color code in #rrggbb format

Regexp^#[a-f0-9]{6}$
example"#c42207"
topics[].subtopics array of object nullable

List of subtopics under this topic

topics[].subtopics[].id string
example"o46btrzamvlev7xhvuuv"
topics[].subtopics[].name string
example"Pizza"
topics[].subtopics[].status string

Status of the topic:

  • draft: the topic has been modified but not processed yet
  • applied: the topic has been processed
  • to_delete: the topic has been removed but the removal has not been processed yet
Enum"draft""applied""to_delete"or any string (open enum)
example"applied"
topics[].subtopics[].color string

Hexadecimal color code in #rrggbb format

Regexp^#[a-f0-9]{6}$
example"#c42207"
200 example
{
    "topics": [
        {
            "id": "r03aptazwuxvkljkf84w",
            "name": "Food",
            "status": "applied",
            "color": "#c42207",
            "subtopics": [
                {
                    "id": "o46btrzamvlev7xhvuuv",
                    "name": "Pizza",
                    "status": "applied",
                    "color": "#2abb17"
                }
            ]
        },
        {
            "id": "r03aptazwuxvkljkf84w",
            "name": "Drinks",
            "status": "applied",
            "color": "#c42207",
            "subtopics": [
                {
                    "id": "o46btrzamvlev7xhvuuv",
                    "name": "Lemonade",
                    "status": "applied",
                    "color": "#2abb17"
                }
            ]
        }
    ]
}