Get Organizations

PUT /api/v1/organizations

This endpoint will retrieve the organizations the authenticated user is a member of.

Request:

curl https://app.useinari.com/api/v1/organizations \
  -H "Authorization: Bearer {token}" 

Response:

{
  "organizations": [
    {
      "active": true,
      "createdAt": "2024-02-11T00:00:00.000Z",
      "name": "Inari",
      "uuid": "uuid-uuid-uuid-uuid"
    }, 
    { ... }
  ]
}

Get Spaces

PUT /api/v1/organizations/<org_uuid>/spaces

This endpoint will retrieve the spaces in the organization.

Request:

curl https://app.useinari.com/api/v1/organizations/uuid-uuid-uuid-uuid/spaces \
  -H "Authorization: Bearer {token}"

Response:

{
  "spaces": [
    {
      "createdAt": "2024-02-11T00:00:00.000Z",
      "description": "Inari Space",
      "name": "Inari Space",
      "uuid": "uuid-uuid-uuid-uuid"
    },
    { ... }
  ]
}

Get Users

PUT /api/v1/organizations/<org_uuid>/users

This endpoint will retrieve the users in the organization.

Request:

curl https://app.useinari.com/api/v1/organizations/uuid-uuid-uuid-uuid/users \
  -H "Authorization: Bearer {token}"

Response:

{
  "users": [
    {
      "uuid": "uuid-uuid-uuid-uuid",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@doe.fake",
      "role": "En",
      "app_admin": true
    }
  ]
}

Add Feedback

PUT /api/v1/zapier/feedbacks

This endpoint will create or update a feedback in Inari. This is primarily used to ingest feedback as a Zapier action from other platforms.

Request:

curl https://app.useinari.com/api/v1/zapier/feedbacks \
  -H "Authorization: Bearer {token}" \
  -d organization_uuid="uuid-uuid-uuid-uuid" \
  -d space_uuid="uuid-uuid-uuid-uuid" \
  -d data_source_type="SLACK_CHANNEL" \
  -d feedback_type="FEEDBACK_RESPONSE" \
  -d data_source_id="SLACK_CHANNEL_ID" \
  -d feedback_contents="This is a customer's feedback about your product"

Response:

{
  "feedbacks": [
    {
      "createdAt": "2024-02-11T00:00:00.000Z",
      "csatResponse": null,
      "customer": {
        "company": null,
        "createdAt": "2024-02-11T00:00:00.000Z",
        "email": null,
        "fullName": null,
        "firstName": null,
        "lastName": null,
        "modifiedAt": "2024-02-11T00:00:00.000Z",
        "phoneNumber": null,
        "role": null,
        "username": null,
        "uuid": "uuid-uuid-uuid-uuid"
      },
      "dataSource": {
        "createdAt": "2024-02-11T00:00:00.000Z",
        "dataSourceId": "SLACK_CHANNEL_ID",
        "dataSourceType": "SLACK_CHANNEL",
        "displayName": "SLACK_CHANNEL",
        "modifiedAt": "2024-02-11T00:00:00.000Z",
        "uuid": "uuid-uuid-uuid-uuid"
      },
      "feedbackContents": "This is a customer's feedback about your product",
      "feedbackDate": "2024-02-11T00:00:00.000Z",
      "npResponse": null,
      "numHighlights": 0,
      "priority": 0,
      "spaceUuid": "uuid-uuid-uuid-uuid",
      "uniqueId": null,
      "uuid": "uuid-uuid-uuid-uuid"
    }
  ]
}

Required attributes

  • organization_uuid (string): Your Inari Organization’s UUID.
  • space_uuid (string): The UUID of the space where the feedback will be ingested.
  • data_source_type (string): The type of data source where the feedback is coming from. Values can be: “UPLOADED_DOC”, “UPLOADED_SHEET”, “SLACK_CHANNEL”, “DISCORD_CHANNEL”, “GONG_CONVO”, “TLDV_TRANSCRIPT”, “GOOGLE_DOC”, “SALESFORCE”, “HUBSPOT”, “ZENDESK”, “NOTION”, “INTERCOM”, “INTERCOM_INBOX”, “JIRA”, “GITHUB_ISSUE”, “ZAPIER_FORM”, “NOTION_PAGE”, “FIREFLIES_TRANSCRIPT”, “G2_REVIEW”, “CAPTERRA_REVIEW”, “APPLE_APPSTORE_REVIEW”, “GOOGLE_PLAY_REVIEW”, “GITHUB_REPO”, “GONG_WORKSPACE”, “ZENDESK_GROUP”
  • feedback_type (string): The type of feedback. Values can be: “FEEDBACK_RESPONSE”, “NPS_RESPONSE”, “CSAT_RESPONSE”, “TEAM_REQUEST”, “USER_INTERVIEW”, “SALES_CALL”, “SUPPORT_EXCHANGE”,“AI_CHAT”.
  • data_source_id (string): Your data source’s ID in-platform. For example, your slack channel’s id.
  • feedback_content (text): Your customer’s feedback contents.

Optional attributes

  • added_by (string): The Inari user who added the feedback. By default, this is the user who is authenticated.
  • analyze_feedback (boolean): If true, Inari will analyze the feedback and extract insights from it. This can only be used in active Organizations.
  • update_customer (boolean): If true, Inari will update the customer’s feedback. This is True by default.
  • data_source_display_name (string): The display name of the data source. This is the name that will be displayed in Inari.
  • customer_id (string): The customer’s ID in your platform. If provided, Inari will try to dedupe customer feedbacks based on this ID.
  • feedback_date (date): The date when the feedback was received. By default, this is the current date.
  • feedback_external_source_id (string): The feedback’s ID in your platform. If provided, Inari will try to dedupe customer feedbacks based on this ID; existing feedbacks will be updated instead of creating new ones.
  • nps_response (number): NPS response of the feedback.
  • csat_response (number): CSAT response of the feedback.
  • priority (string): Priority of the feedback. Values can be: [0, 1, 2, 3, 4].
  • customer_full_name (string): The customer’s full name.
  • customer_first_name (string): The customer’s first name.
  • customer_last_name (string): The customer’s last name.
  • customer_email (string): The customer’s email.
  • customer_username (string): The customer’s username.
  • customer_phone_number (string): The customer’s phone number.
  • customer_role (string): The customer’s role.
  • customer_company (string): The customer’s company.