Skip to main content

Get Customers

GET 
/customers/portal/v1

Get Customers

Request​

Header Parameters

    X-API-KEY stringrequired

    API Key

Responses​

OK

Schema

  • Array [

    • company

    object

    description string

    Description is the description of the company

    external_identifier string

    ExternalIdentifier is a unique identifier of the company across the workspace for easy reference and avoiding duplicates. this can be the company's ID in any external system

    id string

    ID is the unique identifier of the company

    name string

    CreatedAt is the time the company was created

    revenue number

    Revenue is the revenue of the company, it's existance and validations depend on the whether the workspace is B2B or B2C

    created_at string

    CreatedAt is the time the customer was created

    email string

    Email is the email of the customer

    external_identifier string

    ExternalIdentifier is a unique identifier of the customer across the workspace for easy reference and avoiding duplicates. this can be the customer's ID in any external system

    feedbacks

    object[]

    Feedbacks is the feedbacks given by the customer

  • Array [

    • created_at string

    CreatedAt is the time the feedback was created, not to be added when creating a new feedback (it's generated by the system)

    customer
    description string

    Description is the description of the feedback

    id string

    ID is the unique identifier of the feedback, not to be added when creating a new feedback (it's generated by the system)

    insights

    object[]

    Insights is the link between the feedback and the features

  • Array [

    • created_at string

    CreatedAt is the time the insight was created

    description string

    Title is the title of the insight

    feature

    object

    description string

    Description is the description of the feature

    id string

    ID is the unique identifier of the feature

    insights array

    Insights is the link between the feature and the feedbacks

    status

    object

    Status is the status of the feature

    color string

    Color is the color of the status which will be used to represent it in the UI, it is a hex color

    created_at string

    CreatedAt is the time the status was created

    id string

    ID is the unique identifier of the status

    name string

    Name is the name of the status

    type string

    Type is the type of the status, Can be "not_started", "started", "completed" and "canceled"

    title string

    Title is the title of the feature

    feedback
    id string

    ID is the unique identifier of the insight

  • ]

    • sentiment number

    Sentiment is the sentiment of the feedback, it is a float number between -1 and 1 where -1 is negative, 0 is neutral and 1 is positive, don't add it when creating a new feedback (it's generated by the system)

    source

    object

    created_at string

    CreatedAt is the time the source was created

    handle string

    Handle is the unique handle of the source across the workspace

    id string

    ID is the unique identifier of the source

    name string

    Name is the name of the source

    title string

    Title is the title of the feedback

  • ]

    • id string

    ID is the unique identifier of the customer

    metadata

    object

    property name* any
    name string

    CreatedAt is the time the customer was created

    phone_number string

    PhoneNumber is the phone number of the customer

    revenue number

    Revenue is the revenue of the customer, it's existance and validations depend on the whether the workspace is B2B or B2C

  • ]

Loading...