Projects

Get project details

Retrieve project settings, filters, and metadata.

Required permission: projects_read (private projects only).

get/api/v2/projects/{slug}/

Request

  • Base URL: https://app.biel.ai
  • URL: https://app.biel.ai/api/v2/projects/{slug}/
  • Auth: one of:
    • API key in header Authorization
    • none

Path parameters

slugstring required

Project slug identifier.

Response

Project details retrieved successfully

slugstring required

URL-safe project identifier. Auto-generated on creation and immutable thereafter.

uuidstring uuid

Unique project record identifier. Use slug for API paths and the embeddable widget's project attribute.

namestring required

Human-readable project name.

is_privateboolean required

Whether the project is private. Private projects require an API key for read operations.

created_atstring date-time

ISO-8601 timestamp of project creation.

updated_atstring date-time

ISO-8601 timestamp of last project update.

whitelabelboolean required

Whether the 'Powered by Biel.ai' branding is hidden. Requires a Professional plan or above.

Changes

No recorded changes to this operation across all 1 revision of this API.