Streak
App · 30 actions
Work with your Streak CRM in Gmail: create and move boxes through pipelines and stages, set custom fields, add tasks, comments and meeting notes, manage contacts and search everything.
Actions
| Action | What it does |
|---|---|
| Create box | Create a box in a pipeline, in a chosen stage or the first one. |
| Create comment | Add a comment to a box, as the user the API key belongs to. |
| Create contact | Add a contact to a team's directory. |
| Create field | Add a custom field to a pipeline. |
| Create meeting | Log a meeting note or a call on a box. |
| Create pipeline | Create a pipeline in a team with the stages you name (Lead, Qualified and Won when you name none); add more stages and fields with the other actions. |
| Create stage | Add a stage at the end of a pipeline. |
| Create task | Add a task to a box, optionally due at a time and assigned to a teammate. |
| Delete box | Delete a box with its tasks, comments, files and attached emails. |
| Delete comment | Delete a comment from its box. |
| Delete contact | Delete a contact from the team's directory. |
| Delete pipeline | Delete a pipeline. |
| Delete task | Delete a task from its box. |
| Get box | Get one box with its stage, notes and custom field values. |
| Get contact | Get one contact with their emails, phone numbers and title. |
| Get current user | Get the Streak user the API key acts as: key, email and name. |
| Get pipeline | Get one pipeline with its stages, stage order and fields. |
| List boxes | List the boxes (deals, leads, candidates) in a pipeline, one page at a time; ask for the next page with 'Page'. |
| List comments | List the comments on a box. |
| List fields | List the custom fields every box in a pipeline can hold. |
| List meetings | List the meeting notes and call logs on a box. |
| List pipelines | List every pipeline you can see, with its stages and fields. |
| List stages | List a pipeline's stages in the order Streak shows them. |
| List tasks | List the tasks on a box. |
| List teams | List the teams you belong to, with their members. |
| Search | Search boxes, contacts and organizations by words in their names, notes and email addresses. |
| Set box field value | Set a custom field on a box to text, a date, or a ticked or cleared checkbox. |
| Update box | Rename a box, replace its notes or move it to another stage. |
| Update contact | Change a contact's name, job title or notes. |
| Update task | Change a task's text or due time, or mark it done or not done. |
Create box
Create a box in a pipeline, in a chosen stage or the first one.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
- Name
nametextRequired - The box's name.
- Stage
stage_keytext - A stage of the chosen pipeline. Leave empty for the first stage.
- Notes
notestext - Notes for the box. Up to 20,000 characters.
Outputs
boxobject- The new box
Example output
{
"box": {
"boxKey": "agptYWRiZAQw",
"commentCount": 0,
"creationTimestamp": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"fields": {
"1001": "$12,000"
},
"fileCount": 0,
"followerCount": 1,
"followerKeys": [
"agptYWlIEVXNlchgBDA"
],
"gmailThreadCount": 0,
"key": "agptYWRiZAQw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Acme renewal",
"notes": "Renews in March.",
"pipelineKey": "agptYb3cYZAw",
"stageKey": "5001",
"taskTotal": 0
}
}Create comment
Add a comment to a box, as the user the API key belongs to.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
- Comment
messagetextRequired - The comment's text. Up to 20,000 characters.
Outputs
commentobject- The new comment
Example output
{
"comment": {
"boxKey": "agptYWRiZAQw",
"commentKey": "agptYWldBjTBAw",
"creatorKey": "agptYWlIEVXNlchgBDA",
"key": "agptYWldBjTBAw",
"message": "Spoke to their finance team.",
"pipelineKey": "agptYb3cYZAw",
"timestamp": 1761720000000
}
}Create contact
Add a contact to a team's directory. Turn on 'Reuse an existing contact' to get the one with that email instead of a duplicate.
Inputs
- Team
team_keytextRequired - The Streak team. Pick one, or give its key from an earlier step.
- Email
emailtextRequired - The contact's email address.
- First name
given_nametext - The contact's first name.
- Last name
family_nametext - The contact's last name.
- Job title
titletext - The contact's title or role.
- Phone
phonetext - The contact's phone number.
- Notes
notestext - Anything else worth keeping.
- Reuse an existing contact
get_if_existingtrue/false - If a contact with this email already exists, return it instead of creating another.Default:
false.
Outputs
contactobject- The contact
Example output
{
"contact": {
"addresses": [],
"creationDate": 1761720000000,
"emailAddresses": [
"billie@example.com"
],
"familyName": "Jean",
"givenName": "Billie",
"key": "VGVhbUNvbnRhY3Qsfn5zdHJlYWtsb25naWR-fjc1MTg3NDcyMDY",
"other": "",
"phoneNumbers": [],
"teamKey": "agxzfm1haWxmb29nYWVyEQsSBFRlYW0YgICIvJO1pQgM",
"title": "Head of Finance"
}
}Create field
Add a custom field to a pipeline. Boxes in it can then hold a value for the field.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
- Name
nametextRequired - The field's name.
- Type
field_typetextRequired - What the field holds.One of:
TEXT_INPUT(Text),DATE,CHECKBOX.
Outputs
fieldobject- The new field
Example output
{
"field": {
"key": "1002",
"lastUpdatedTimestamp": 1761720000000,
"name": "Renewal date",
"type": "DATE"
}
}Create meeting
Log a meeting note or a call on a box.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
- Type
meeting_typetext - A meeting note or a call log.One of:
MEETING_NOTES(Meeting notes (default)),CALL_LOG(Call log). Default:MEETING_NOTES. - Started
start_timedate and timeRequired - When the meeting or call started.
- Length (minutes)
duration_minutesnumber - How long it ran, 1 to 1440 minutes.From 1 to 1440.
- Notes
notestext - What was said or decided. Up to 20,000 characters.
Outputs
meetingobject- The new meeting
Example output
{
"meeting": {
"boxKey": "agptYWRiZAQw",
"creationDate": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"duration": 1800000,
"key": "agxzfm1haWxmb29",
"meetingType": "CALL_LOG",
"notes": "Agreed next steps.",
"pipelineKey": "agptYb3cYZAw",
"startTimestamp": 1762000000000
}
}Create pipeline
Create a pipeline in a team with the stages you name (Lead, Qualified and Won when you name none); add more stages and fields with the other actions.
Inputs
- Name
nametextRequired - The pipeline's name.
- Team
team_keytextRequired - The Streak team. Pick one, or give its key from an earlier step.
- Stage names
stage_namestext - The pipeline's stages in order, separated by commas. Streak needs at least one.Default:
Lead, Qualified, Won. - Share with the whole team
team_widetrue/false - Everyone in the team can see the pipeline.Default:
false.
Outputs
pipelineobject- The new pipeline
Example output
{
"pipeline": {
"aclEntries": [],
"creationTimestamp": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"fields": [
{
"key": "1001",
"lastUpdatedTimestamp": 1761720000000,
"name": "Deal size",
"type": "TEXT_INPUT"
}
],
"key": "agptYb3cYZAw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Sales",
"pipelineKey": "agptYb3cYZAw",
"stageOrder": [
"5001",
"5002"
],
"stages": {
"5001": {
"key": "5001",
"name": "Lead"
},
"5002": {
"key": "5002",
"name": "Won"
}
}
}
}Create stage
Add a stage at the end of a pipeline.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
- Name
nametextRequired - The stage's name.
Outputs
stageobject- The new stage
Example output
{
"stage": {
"key": "5003",
"name": "Negotiation"
}
}Create task
Add a task to a box, optionally due at a time and assigned to a teammate.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
- Task
texttextRequired - What needs doing.
- Due
due_datedate and time - When the task is due.
- Assign to
assignee_emailtext - The email address of a teammate in the box's team.
Outputs
taskobject- The new task
Example output
{
"task": {
"assignedToSharingEntries": [],
"boxKey": "agptYWRiZAQw",
"creationDate": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"dueDate": 1762000000000,
"key": "agxzfmWxmPK9xZsKDA",
"lastStatusChangeDate": 1761720000000,
"pipelineKey": "agptYb3cYZAw",
"status": "NOT_DONE",
"text": "Send the quote"
}
}Delete box
Delete a box with its tasks, comments, files and attached emails.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
Outputs
deletedtrue/false- Always true once deleted
keytext- The key of the box deleted
Example output
{
"deleted": true,
"key": "agptYWRiZAQw"
}Delete comment
Delete a comment from its box.
Inputs
- Comment
comment_keytextRequired - The comment's key, from 'List comments' or 'Create comment'.
Outputs
deletedtrue/false- Always true once deleted
keytext- The key of the comment deleted
Example output
{
"deleted": true,
"key": "agptYWldBjTBAw"
}Delete contact
Delete a contact from the team's directory.
Inputs
- Contact
contact_keytextRequired - The contact's key, from 'Create contact', 'Search' or an earlier step.
Outputs
deletedtrue/false- Always true once deleted
keytext- The key of the contact deleted
Example output
{
"deleted": true,
"key": "VGVhbUNvbnRhY3Qsfn5zdHJlYWtsb25naWR-fjc1MTg3NDcyMDY"
}Delete pipeline
Delete a pipeline. Streak only allows it once the pipeline has no boxes.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
keytext- The key of the pipeline deleted
Example output
{
"deleted": true,
"key": "agptYb3cYZAw"
}Delete task
Delete a task from its box.
Inputs
- Task
task_keytextRequired - The task's key, from 'List tasks' or 'Create task'.
Outputs
deletedtrue/false- Always true once deleted
keytext- The key of the task deleted
Example output
{
"deleted": true,
"key": "agxzfmWxmPK9xZsKDA"
}Get box
Get one box with its stage, notes and custom field values.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
Outputs
boxobject- The box
Example output
{
"box": {
"boxKey": "agptYWRiZAQw",
"commentCount": 0,
"creationTimestamp": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"fields": {
"1001": "$12,000"
},
"fileCount": 0,
"followerCount": 1,
"followerKeys": [
"agptYWlIEVXNlchgBDA"
],
"gmailThreadCount": 0,
"key": "agptYWRiZAQw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Acme renewal",
"notes": "Renews in March.",
"pipelineKey": "agptYb3cYZAw",
"stageKey": "5001",
"taskTotal": 0
}
}Get contact
Get one contact with their emails, phone numbers and title.
Inputs
- Contact
contact_keytextRequired - The contact's key, from 'Create contact', 'Search' or an earlier step.
Outputs
contactobject- The contact
Example output
{
"contact": {
"addresses": [],
"creationDate": 1761720000000,
"emailAddresses": [
"billie@example.com"
],
"familyName": "Jean",
"givenName": "Billie",
"key": "VGVhbUNvbnRhY3Qsfn5zdHJlYWtsb25naWR-fjc1MTg3NDcyMDY",
"other": "",
"phoneNumbers": [],
"teamKey": "agxzfm1haWxmb29nYWVyEQsSBFRlYW0YgICIvJO1pQgM",
"title": "Head of Finance"
}
}Get current user
Get the Streak user the API key acts as: key, email and name.
Inputs
None.
Outputs
userobject- The connected user
Example output
{
"user": {
"creationTimestamp": 1747660765134,
"displayName": "Jo Bloggs",
"email": "jo@example.com",
"key": "agptYWlIEVXNlchgBDA",
"lastSeenTimestamp": 1761728000000,
"userKey": "agptYWlIEVXNlchgBDA"
}
}Get pipeline
Get one pipeline with its stages, stage order and fields.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
Outputs
pipelineobject- The pipeline
Example output
{
"pipeline": {
"aclEntries": [],
"creationTimestamp": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"fields": [
{
"key": "1001",
"lastUpdatedTimestamp": 1761720000000,
"name": "Deal size",
"type": "TEXT_INPUT"
}
],
"key": "agptYb3cYZAw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Sales",
"pipelineKey": "agptYb3cYZAw",
"stageOrder": [
"5001",
"5002"
],
"stages": {
"5001": {
"key": "5001",
"name": "Lead"
},
"5002": {
"key": "5002",
"name": "Won"
}
}
}
}List boxes
List the boxes (deals, leads, candidates) in a pipeline, one page at a time; ask for the next page with 'Page'.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
- Stage
stage_keytext - Only boxes in this stage.
- Order
sort_bytext - Which boxes come first.One of:
lastUpdatedTimestamp(Recently updated first (default)),creationTimestamp(Newest first). - Page size
limitnumber - How many boxes per page, 1 to 100.From 1 to 100.
- Page
pagenumber - Which page to get. The first page is 0.At least 0.
Outputs
boxeslist- The boxes
countnumber- How many on this page
has_next_pagetrue/false- Whether another page may follow
pagenumber- The page returned
Example output
{
"boxes": [
{
"boxKey": "agptYWRiZAQw",
"commentCount": 0,
"creationTimestamp": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"fields": {
"1001": "$12,000"
},
"fileCount": 0,
"followerCount": 1,
"followerKeys": [
"agptYWlIEVXNlchgBDA"
],
"gmailThreadCount": 0,
"key": "agptYWRiZAQw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Acme renewal",
"notes": "Renews in March.",
"pipelineKey": "agptYb3cYZAw",
"stageKey": "5001",
"taskTotal": 0
}
],
"count": 1,
"has_next_page": false,
"page": 0
}List comments
List the comments on a box.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
Outputs
commentslist- The comments
countnumber- How many
Example output
{
"comments": [
{
"boxKey": "agptYWRiZAQw",
"commentKey": "agptYWldBjTBAw",
"creatorKey": "agptYWlIEVXNlchgBDA",
"key": "agptYWldBjTBAw",
"message": "Spoke to their finance team.",
"pipelineKey": "agptYb3cYZAw",
"timestamp": 1761720000000
}
],
"count": 1
}List fields
List the custom fields every box in a pipeline can hold.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
Outputs
countnumber- How many
fieldslist- The fields
Example output
{
"count": 1,
"fields": [
{
"key": "1002",
"lastUpdatedTimestamp": 1761720000000,
"name": "Renewal date",
"type": "DATE"
}
]
}List meetings
List the meeting notes and call logs on a box.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
Outputs
countnumber- How many
meetingslist- The meetings
Example output
{
"count": 1,
"meetings": [
{
"boxKey": "agptYWRiZAQw",
"creationDate": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"duration": 1800000,
"key": "agxzfm1haWxmb29",
"meetingType": "CALL_LOG",
"notes": "Agreed next steps.",
"pipelineKey": "agptYb3cYZAw",
"startTimestamp": 1762000000000
}
]
}List pipelines
List every pipeline you can see, with its stages and fields.
Inputs
None.
Outputs
countnumber- How many
pipelineslist- The pipelines
Example output
{
"count": 1,
"pipelines": [
{
"aclEntries": [],
"creationTimestamp": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"fields": [
{
"key": "1001",
"lastUpdatedTimestamp": 1761720000000,
"name": "Deal size",
"type": "TEXT_INPUT"
}
],
"key": "agptYb3cYZAw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Sales",
"pipelineKey": "agptYb3cYZAw",
"stageOrder": [
"5001",
"5002"
],
"stages": {
"5001": {
"key": "5001",
"name": "Lead"
},
"5002": {
"key": "5002",
"name": "Won"
}
}
}
]
}List stages
List a pipeline's stages in the order Streak shows them.
Inputs
- Pipeline
pipeline_keytextRequired - The pipeline. Pick one, or give its key from an earlier step.
Outputs
countnumber- How many
stageslist- The stages
Example output
{
"count": 1,
"stages": [
{
"key": "5001",
"name": "Lead"
}
]
}List tasks
List the tasks on a box.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
Outputs
countnumber- How many
taskslist- The tasks
Example output
{
"count": 1,
"tasks": [
{
"assignedToSharingEntries": [],
"boxKey": "agptYWRiZAQw",
"creationDate": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"dueDate": 1762000000000,
"key": "agxzfmWxmPK9xZsKDA",
"lastStatusChangeDate": 1761720000000,
"pipelineKey": "agptYb3cYZAw",
"status": "NOT_DONE",
"text": "Send the quote"
}
]
}List teams
List the teams you belong to, with their members. A team's key is what 'Create pipeline' and 'Create contact' need.
Inputs
None.
Outputs
countnumber- How many
teamslist- The teams
Example output
{
"count": 1,
"teams": [
{
"creationDate": 1747660765134,
"creator": "agptYWlIEVXNlchgBDA",
"key": "agxzfm1haWxmb29nYWVyEQsSBFRlYW0YgICIvJO1pQgM",
"members": [
{
"displayName": "Jo Bloggs",
"email": "jo@example.com",
"fullName": "Jo Bloggs",
"inviteStatus": "Accepted",
"role": "Owner",
"userKey": "agptYWlIEVXNlchgBDA"
}
],
"name": "Jo's Team",
"sharingRestrictedToTeam": false
}
]
}Search
Search boxes, contacts and organizations by words in their names, notes and email addresses. Boxes can be narrowed to a pipeline.
Inputs
- Search for
querytextRequired - The words or email address to look for.
- Only in pipeline
pipeline_keytext - Limit box results to this pipeline.
- Only in stage
stage_keytext - Limit box results to this stage.
Outputs
boxeslist- Matching boxes
contactslist- Matching contacts
countnumber- How many in all
organizationslist- Matching organizations
Example output
{
"boxes": [
{
"boxKey": "agptYWRiZAQw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Acme renewal",
"pipelineKey": "agptYb3cYZAw",
"stageKey": "5001"
}
],
"contacts": [],
"count": 1,
"organizations": []
}Set box field value
Set a custom field on a box to text, a date, or a ticked or cleared checkbox. The field must be of the matching type.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
- Pipeline
pipeline_keytext - The box's pipeline. It only fills the dropdown below with that pipeline's choices; nothing is moved.
- Field
field_keytextRequired - The field to set. Pick one, or give its key.
- Set it to
value_typetext - What to write into the field.One of:
text(Text (default)),date,checked(Tick the checkbox),unchecked(Clear the checkbox). Default:text. - Text
text_valuetext - The text to write.Only when Set it to is Text (default).
- Date
date_valuedate - The date to write, stored at midnight UTC.Only when Set it to is Date.
Outputs
box_keytext- The box changed
field_keytext- The field set
valuetext- The value Streak now holds
Example output
{
"box_key": "agptYWRiZAQw",
"field_key": "1001",
"value": "$12,000"
}Update box
Rename a box, replace its notes or move it to another stage. Only the fields given change.
Inputs
- Box
box_keytextRequired - The box's key, from 'List boxes', 'Search' or an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Notes
notestext - New notes, replacing the old. Leave empty to keep them.
- Pipeline
pipeline_keytext - The box's pipeline. It only fills the dropdown below with that pipeline's choices; nothing is moved.
- Move to stage
stage_keytext - A stage of the box's pipeline. Leave empty to keep it.
Outputs
boxobject- The updated box
Example output
{
"box": {
"boxKey": "agptYWRiZAQw",
"commentCount": 0,
"creationTimestamp": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"fields": {
"1001": "$12,000"
},
"fileCount": 0,
"followerCount": 1,
"followerKeys": [
"agptYWlIEVXNlchgBDA"
],
"gmailThreadCount": 0,
"key": "agptYWRiZAQw",
"lastUpdatedTimestamp": 1761720000000,
"name": "Acme renewal 2026",
"notes": "Renews in March.",
"pipelineKey": "agptYb3cYZAw",
"stageKey": "5002",
"taskTotal": 0
}
}Update contact
Change a contact's name, job title or notes. Only the fields given change; emails and phone numbers are kept as they are.
Inputs
- Contact
contact_keytextRequired - The contact's key, from 'Create contact', 'Search' or an earlier step.
- First name
given_nametext - A new first name. Leave empty to keep it.
- Last name
family_nametext - A new last name. Leave empty to keep it.
- Job title
titletext - A new title. Leave empty to keep it.
- Notes
notestext - New notes. Leave empty to keep them.
Outputs
contactobject- The updated contact
Example output
{
"contact": {
"addresses": [],
"creationDate": 1761720000000,
"emailAddresses": [
"billie@example.com"
],
"familyName": "Jean",
"givenName": "Billie",
"key": "VGVhbUNvbnRhY3Qsfn5zdHJlYWtsb25naWR-fjc1MTg3NDcyMDY",
"other": "",
"phoneNumbers": [],
"teamKey": "agxzfm1haWxmb29nYWVyEQsSBFRlYW0YgICIvJO1pQgM",
"title": "CFO"
}
}Update task
Change a task's text or due time, or mark it done or not done. Only the fields given change.
Inputs
- Task
task_keytextRequired - The task's key, from 'List tasks' or 'Create task'.
- Task
texttext - New text. Leave empty to keep it.
- Due
due_datedate and time - A new due time. Leave empty to keep it.
- Status
statustext - Mark the task done or not done. Leave empty to keep it.One of:
NOT_DONE(Not done),DONE.
Outputs
taskobject- The updated task
Example output
{
"task": {
"assignedToSharingEntries": [],
"boxKey": "agptYWRiZAQw",
"creationDate": 1761720000000,
"creatorKey": "agptYWlIEVXNlchgBDA",
"dueDate": 1762000000000,
"key": "agxzfmWxmPK9xZsKDA",
"lastStatusChangeDate": 1761720000000,
"pipelineKey": "agptYb3cYZAw",
"status": "DONE",
"text": "Send the quote"
}
}