# Pointagram

Pointagram is a gamification tool that increases motivation and team achievements. Keep your team goal-oriented and celebrate great performance together.

- **Category:** productivity
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `POINTAGRAM`
- **Version:** 00000000_00

## Tools

### Add Score

**Slug:** `POINTAGRAM_ADD_SCORE`

Tool to add points to Pointagram players in a score series. Use when you need to award points with optional tags, descriptions, and automatic player creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags displayed with points. Each tag should have a 'name' field. |
| `points` | integer | No | Number of points to award. Use this OR pointtype_name. |
| `comment` | string | No | Description visible in the news feed about this score entry. |
| `player_id` | string | No | Internal Pointagram player identifier. Use this if you have the player's ID. |
| `score_time` | string | No | Sets transaction timestamp in datetime format (e.g., ISO 8601). |
| `player_name` | string | No | Player's display name for identification. Use when player_id is not available. |
| `player_email` | string | No | Player's email address for identification. Use when player_id is not available. |
| `create_player` | integer | No | Set to 1 to automatically create missing players. Leave unset or set to 0 to not create players. |
| `pointtype_name` | string | No | Named point type to assign. Use this OR points. |
| `scoreseries_id` | string | No | ID of the target score series. Use this OR scoreseries_name. |
| `source_score_id` | string | No | Transaction identifier. Reusing this ID will revoke the previous entry with the same ID. |
| `scoreseries_name` | string | No | Name of the target score series. Use this OR scoreseries_id. |
| `player_external_id` | string | No | Your system's unique player identifier. Use for integration with external systems. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Competition Players

**Slug:** `POINTAGRAM_LIST_COMPETITION_PLAYERS`

Tool to fetch competition players and standings in Pointagram. Returns detailed player rankings, scores, and competition participation data. Use when you need to retrieve player standings, competition leaderboards, or analyze player performance across competitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `player_id` | string | No | Filter by specific player ID to get their competition participation. |
| `competition_id` | string | No | Filter players by specific competition ID. If not provided, returns players from all competitions. |
| `player_external_id` | string | No | Filter by external player identifier from your system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Competitions

**Slug:** `POINTAGRAM_LIST_COMPETITIONS`

Tool to fetch competitions in Pointagram with optional filtering. Use when you need to retrieve competition information including rankings and scores. Supports filtering by player (email, name, external ID), competition ID, or access key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | The search value to match against the criteria specified in search_by parameter. Used to filter competitions by player information. |
| `accesskey` | string | No | Filter results to show only competitions associated with a specific access key identifier. |
| `search_by` | string ("Email" | "Name" | "External Id") | No | Specifies the search criteria type to filter competitions by player. Accepts 'Email', 'Name', or 'External Id'. Used in combination with 'filter' parameter. |
| `competition_id` | string | No | Filter results to show only a specific competition by its unique ID. When provided, returns data for a single competition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Players

**Slug:** `POINTAGRAM_LIST_PLAYERS`

Tool to fetch and list players in Pointagram with optional filtering. Use when you need to retrieve player information including name, email, external ID, and status. Supports filtering by email, name, or external ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | The search value to match against the specified search_by field. Used in combination with 'search_by' parameter to filter results. |
| `search_by` | string ("Email" | "Name" | "External Id") | No | Specifies the search field to filter players. Accepts 'Email', 'Name', or 'External Id'. If provided, 'filter' parameter must also be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Score Series

**Slug:** `POINTAGRAM_LIST_SCORE_SERIES`

Tool to list all score series in Pointagram. Use when you need to retrieve all configured score series collections that track and measure different point types.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Score Series History

**Slug:** `POINTAGRAM_LIST_SCORE_SERIES_HISTORY`

Tool to fetch historical point data for a score series. Returns time-series data of points awarded over time with optional filtering by tags, teams, players, and time range. Use when you need to retrieve historical transaction data for a specific score series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum rows per request (default: 50, maximum: 1000). |
| `time_to` | string | No | End time in UTC format "YYYY-MM-DD HH:MM:SS". |
| `offset_id` | string | No | For pagination - use previous response's last row ID. Must be used together with offset_timestamp. |
| `time_from` | string | No | Start time in UTC format "YYYY-MM-DD HH:MM:SS". |
| `tags_filter` | string | No | Filter by specific tags in JSON format: [{"id":"13","type":1},{"id":"14","type":1}] where type 1=tags, type 2=point type. |
| `show_revoked` | integer | No | Set to 1 to include revoked points; default is 0. |
| `teams_filter` | string | No | Filter by team IDs in JSON format: ["20"]. |
| `player_filter` | string | No | Filter by player profile IDs in JSON format: ["19145"]. |
| `scoreseriesid` | integer | Yes | The ID of the score series to fetch history for. This is a required parameter. |
| `tags_or_filter` | string | No | Alternative tag filtering with OR logic. Same format as tags_filter: [{"id":"13","type":1}]. |
| `offset_timestamp` | string | No | For pagination - use previous response's last row timestamp. Must be used together with offset_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Score Series Point Types

**Slug:** `POINTAGRAM_LIST_SCORE_SERIES_POINT_TYPES`

Tool to fetch point types for a specific score series in Pointagram. Use when you need to retrieve the different types of points that can be awarded within a score series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scoreseries` | integer | Yes | Id of the score series to fetch Point Types for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `POINTAGRAM_LIST_TEAMS`

Tool to fetch and list all teams in Pointagram. Returns team information including ID, name, and icon. Use when you need to retrieve all available teams.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |