> For the complete documentation index, see [llms.txt](https://docs.erathos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.erathos.com/connectors/apis/feedz.md).

# Feedz

### Using the Erathos platform

When selecting Feedz as a new connector on the Erathos platform, you will need to name your connection and fill in the following form:

* **Token** — your Feedz API v2 integration key, used to authenticate all requests to the Feedz API

With this connection created you can seamlessly move your Feedz data to your BigQuery, Redshift or Postgres data warehouse.

### How to find my token?

To generate your Feedz API token, you must be a **System Administrator** on your Feedz account. Navigate to **Settings → Integrations → API Integration Key v2** and generate a new key.

Once the token is generated, copy it and paste it into the **Token** field on the Erathos platform. Then click **Save and close** to complete the setup.

Note: if you need to test the integration before connecting to production data, Feedz provides a Sandbox environment at `sandbox.feedz.dev` — request access through your Feedz account manager.

## Endpoints and fields

### employees

Sync type availability: Full-refresh

| Field            | Type      |
| ---------------- | --------- |
| employeeId       | text      |
| name             | text      |
| full\_name       | text      |
| email            | text      |
| cpf              | text      |
| admission\_at    | timestamp |
| birth\_at        | timestamp |
| status           | text      |
| department       | text      |
| job\_description | text      |
| direct\_manager  | text      |
| company          | text      |
| branch           | text      |
| role             | text      |
| origin           | text      |
| team             | text      |
| groups           | text      |

### departments

Sync type availability: Full-refresh

| Field | Type |
| ----- | ---- |
| id    | text |
| name  | text |

### branches

Sync type availability: Full-refresh

| Field | Type |
| ----- | ---- |
| id    | text |
| name  | text |

### profile\_job\_descriptions

Sync type availability: Full-refresh

| Field          | Type |
| -------------- | ---- |
| id             | text |
| title          | text |
| description    | text |
| id\_job\_group | text |

### profile\_job\_groups

Sync type availability: Full-refresh

| Field       | Type      |
| ----------- | --------- |
| id          | text      |
| title       | text      |
| description | text      |
| idCompany   | text      |
| createdAt   | timestamp |
| updatedAt   | timestamp |

### turnovers

Sync type availability: Full-refresh

| Field                 | Type      |
| --------------------- | --------- |
| id                    | text      |
| reason                | text      |
| type                  | text      |
| department            | text      |
| last\_day\_working    | timestamp |
| profile.id            | text      |
| profile.name          | text      |
| profile.email         | text      |
| profile.dt\_admission | timestamp |
| profile.status        | text      |

### digital\_admission

Sync type availability: Full-refresh

| Field               | Type      |
| ------------------- | --------- |
| id                  | text      |
| name                | text      |
| email               | text      |
| deadline\_at        | timestamp |
| created\_at         | timestamp |
| updated\_at         | timestamp |
| profile\_department | text      |
| profile\_job        | text      |
| status              | text      |

### celebrations

Sync type availability: Full and incremental refresh

[Cursor](/platform/connections/sync-types.md#understanding-cursors): `dt_create`

| Field             | Type      | Cursor |
| ----------------- | --------- | ------ |
| id                | text      |        |
| id\_profile\_from | text      |        |
| id\_profile\_to   | text      |        |
| comment           | text      |        |
| dt\_create        | timestamp | ✓      |

### mood

Sync type availability: Full and incremental refresh

[Cursor](/platform/connections/sync-types.md#understanding-cursors): `date`

| Field       | Type  | Cursor |
| ----------- | ----- | ------ |
| mood        | text  |        |
| description | text  |        |
| department  | text  |        |
| branch      | text  |        |
| name        | text  |        |
| average     | float |        |
| date        | date  | ✓      |

### objectives

Sync type availability: Full-refresh

| Field              | Type  |
| ------------------ | ----- |
| id                 | text  |
| id\_parent         | text  |
| id\_owner          | text  |
| id\_company        | text  |
| id\_department     | text  |
| objective          | text  |
| percentage\_status | float |

### complete\_survey

Sync type availability: Full-refresh

Parent of [`complete_survey_answers`](#complete_survey_answers)

| Field                | Type |
| -------------------- | ---- |
| id                   | text |
| id\_company          | text |
| id\_profile\_created | text |
| title                | text |

### complete\_survey\_answers

Sync type availability: Full-refresh

Child of [`complete_survey`](#complete_survey)

| Field                   | Type |
| ----------------------- | ---- |
| id                      | text |
| id\_company             | text |
| id\_survey              | text |
| id\_question            | text |
| id\_profile             | text |
| id\_profile\_department | text |

### fast\_survey

Sync type availability: Full-refresh

Parent of [`fast_survey_answers`](#fast_survey_answers)

| Field                | Type |
| -------------------- | ---- |
| id                   | text |
| id\_company          | text |
| id\_profile\_created | text |
| question             | text |

### fast\_survey\_answers

Sync type availability: Full-refresh

Child of [`fast_survey`](#fast_survey)

| Field            | Type  |
| ---------------- | ----- |
| id               | text  |
| id\_fast\_survey | text  |
| id\_profile      | text  |
| score            | float |
| answer           | text  |
| answer\_option   | text  |

### pulse

Sync type availability: Full-refresh

| Field           | Type |
| --------------- | ---- |
| id              | text |
| id\_company     | text |
| id\_profile     | text |
| id\_departments | text |
| name            | text |
| description     | text |

### enps

Sync type availability: Full-refresh

| Field       | Type      |
| ----------- | --------- |
| dt\_create  | timestamp |
| dt\_final   | timestamp |
| departments | text      |
| detractors  | integer   |
| passives    | integer   |
| promoters   | integer   |

### notifications

Sync type availability: Full and incremental refresh

[Cursor:](/platform/connections/sync-types.md#understanding-cursors) `dt_created`

| Field           | Type      | Cursor |
| --------------- | --------- | ------ |
| id              | text      |        |
| link            | text      |        |
| custom\_message | text      |        |
| dt\_created     | timestamp | ✓      |
| message         | text      |        |

## Entity Relationships

```mermaid
erDiagram
    complete_survey ||--o{ complete_survey_answers : "id = id_survey"
    fast_survey ||--o{ fast_survey_answers : "id = id_fast_survey"
    profile_job_groups ||--o{ profile_job_descriptions : "id = id_job_group"
    departments ||--o{ objectives : "id = id_department"
    departments ||--o{ complete_survey_answers : "id = id_profile_department"
    departments ||--o{ pulse : "id = id_departments"

    employees { string employeeId PK }
    departments { string id PK }
    branches { string id PK }
    profile_job_descriptions { string id PK }
    profile_job_groups { string id PK }
    turnovers { string id PK }
    digital_admission { string id PK }
    celebrations { string id PK }
    mood { string mood }
    objectives { string id PK }
    complete_survey { string id PK }
    complete_survey_answers { string id PK }
    fast_survey { string id PK }
    fast_survey_answers { string id PK }
    pulse { string id PK }
    enps { timestamp dt_create }
    notifications { string id PK }
```