Backoffice API
  1. Projects
Backoffice API
  • Back to home
  • Community
  • Events
    • Blocks
      • Event blocks by id
      • Manage Event blocks by id
      • Event Block entries by ids
      • Manage Event Block entries by ids
    • List events
      GET
    • Create Event
      POST
    • Event by id
      GET
    • Update Event by id
      PATCH
    • Remove Event by id
      DELETE
    • Event occurrences by id
      GET
    • Update Event Block by ids
      PATCH
  • Organizations
    • Blocks
      • Organization blocks by id
      • Manage Organization blocks by id
      • Organization Block entries by ids
      • Manage Organization Block entries by ids
    • List organizations
      GET
    • Create Organization
      POST
    • Organization by id
      GET
    • Update Organization by id
      PATCH
    • Remove Organization by id
      DELETE
    • Update Organization Block by ids
      PATCH
  • People
    • Blocks
      • Person blocks by id
      • Manage Person blocks by id
      • Person Block entries by ids
      • Manage Person Block entries by ids
    • List people
      GET
    • Create Person
      POST
    • Person by id
      GET
    • Update Person by id
      PATCH
    • Remove Person by id
      DELETE
    • Update Person Block by ids
      PATCH
  • Projects
    • Blocks
      • Project blocks by id
      • Manage Project blocks by id
      • Project Block entries by ids Copy
      • Manage Project Block entries by ids
    • List projects
      GET
    • Create Project
      POST
    • Project by id
      GET
    • Update Project by id
      PATCH
    • Remove Project by id
      DELETE
    • Update Project Block by ids
      PATCH
  1. Projects

Project by id

GET
/projects/{id}

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
API Key
Add parameter in query
x-api-key
Example:
x-api-key: ********************
or
Path Params

Responses

🟢200Success
application/json
Body

🟠400Invalid UUID
🟠401Unauthorized API KEY
🟠403Unauthorized roles
🟠404Entity not found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://prod.your-api-server.com/api/community/v2/projects/{{community_project_id}}' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "cover_image_key": "string",
        "profile_image_key": "string",
        "profile": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
            "profile_categories": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2"
                }
            ],
            "profile_type_id": "fcb02d6f-d919-45dd-b606-b0bf8279ebd8",
            "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c"
        },
        "description": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "locale": "string",
                "blocks": [
                    {
                        "kind": "richtext",
                        "content_html": "string",
                        "image": {
                            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                            "file_key": "string",
                            "credit": "string",
                            "caption_html": "<p>Caption example by Omerlo</p>",
                            "caption_text": "Caption example by Omerlo",
                            "gravity": "center"
                        },
                        "slideshow": {
                            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                            "images": [
                                {
                                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                                    "file_key": "string",
                                    "credit": "string",
                                    "caption_html": "<p>Caption example by Omerlo</p>",
                                    "caption_text": "Caption example by Omerlo",
                                    "gravity": "center"
                                }
                            ]
                        },
                        "video": {
                            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                            "video_id": "165252b3-cd77-4f41-a38f-02417eac7441",
                            "url": "http://example.com",
                            "provider": "youtube",
                            "credit": "Credit example",
                            "caption_html": "<p>Caption example by Omerlo</p>",
                            "caption_text": "Caption example by Omerlo",
                            "is_monetized": false,
                            "is_tracking_enabled": false
                        }
                    }
                ],
                "deleted_at": "2019-08-24T14:15:22Z"
            }
        ],
        "address": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "locale": "en",
                "country": "string",
                "city": "string",
                "street": "string",
                "location": "string",
                "deleted_at": "2019-08-24T14:15:22Z"
            }
        ],
        "contact": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "locale": "en",
                "email": "user@example.com",
                "phone": "string",
                "facebook": "string",
                "linkedin": "string",
                "instagram": "string",
                "twitter": "string",
                "bluesky": "string",
                "website": "string",
                "deleted_at": "2019-08-24T14:15:22Z"
            }
        ],
        "locales": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "locale": "en",
                "name": "string",
                "summary_html": "string",
                "description_html": "string",
                "deleted_at": "2019-08-24T14:15:22Z"
            }
        ],
        "inserted_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
    }
}
Modified at 2025-06-19 16:40:38
Previous
Create Project
Next
Update Project by id
Built with