Bugcrowd Docs | Changelogs | Api_webhook

Introducing New API Versioning System

2025-09-09T00:00:00+00:00

Transforming Bugcrowd API Architecture for a Better Developer Experience

We are excited to announce significant improvements to our API architecture, designed to enhance performance, simplify usage, and streamline future updates. These enhancements include:

Structural Improvements: Reducing the dependency on deeply nested includes for more efficient calls.
New Serializers: A new set of serializers to eliminate complex queries and significantly boost performance.
Versioning System Fix: Transitioning from a date-based versioning system to a semantic versioning (SemVer) system. This change removes the need for serializer transformers, simplifying the developer process and improving stability.

Consolidation of Versions

As a result of these improvements, all current date-based API versions will be consolidated into a single major API version, V1. This V1 version will be backward compatible with all existing date-based API versions. Customers currently using a date-based version will be automatically migrated to V1, and their API keys will be updated accordingly, requiring no action on their part.

Versioning and API Keys

API keys will be pinned to a major release (starting with V1).
New features and bugfixes will be delivered as transparent point releases, maintaining backward compatibility within the major release.
There are no changes to the current API functionality.

The improved versioning system will facilitate faster and more efficient delivery of new API features to customers.

Next Steps

These API changes will be communicated to current API customers and rolled out over the next month. A customer-facing technical blog post with more details will be available soon.

New API version released 2025-04-23

2025-04-23T00:00:00+00:00

Add `submission_activities` index endpoint

Added endpoint to query submission activities, this allow to get activities for a
specific submission and paginate them over the 100 on includable resources|
event and actor can be included in the response 

{
    "data": [
        {
            "id": "ccfcb1d0-becd-45ec-a3ab-030a748b525e",
            "type": "activity",
            "attributes": {
                "created_at": "2025-02-05T06:00:00.000Z",
                "key": "submission.transitioned"
            },
            "relationships": {
                "actor": {
                    "data": {
                        "id": "9e30878b-265b-4455-9ee6-12ccc3288c2f",
                        "type": "identity"
                    },
                    "links": {
                        "related": {
                            "href": "(NOT IMPLEMENTED YET)"
                        }
                    }
                },
                "event": {
                    "data": {
                        "id": "f369a0f5-0305-4866-8416-93d0c0a55db0",
                        "type": "event"
                    },
                    "links": {
                        "related": {
                            "href": "(NOT IMPLEMENTED YET)"
                        }
                    }
                },
                "program": {
                    "data": {
                        "id": "53c5855e-fd12-4e9c-a298-8d0f3cda9989",
                        "type": "program"
                    },
                    "links": {
                        "related": {
                            "href": "/programs/53c5855e-fd12-4e9c-a298-8d0f3cda9989"
                        }
                    }
                },
                "submission": {
                    "data": {
                        "id": "cafd24c8-b2e5-44b6-87df-0190f0d3da74",
                        "type": "submission"
                    },
                    "links": {
                        "related": {
                            "href": "/submissions/cafd24c8-b2e5-44b6-87df-0190f0d3da74"
                        }
                    }
                }
            },
            "links": {
                "self": "(NOT IMPLEMENTED YET)"
            }
        }
    ],
    "included": [
        {
            "id": "9e30878b-265b-4455-9ee6-12ccc3288c2f",
            "type": "identity",
            "attributes": {
                "name": "bounty-viewer",
                "email": "bounty-viewer@redama.com",
                "staff": false
            },
            "links": {
                "self": "(NOT IMPLEMENTED YET)"
            }
        },
        {
            "id": "f369a0f5-0305-4866-8416-93d0c0a55db0",
            "type": "event",
            "attributes": {
                "created_at": "2025-02-05T01:12:36.909Z",
                "key": "submission.updated.transitioned",
                "data": {
                    "changes": {
                        "substate": {
                            "to": "not_applicable",
                            "from": "nue"
                        }
                    },
                    "duplicate_ids": []
                }
            },
            "relationships": {
                "resource": {
                    "data": {
                        "id": "cafd24c8-b2e5-44b6-87df-0190f0d3da74",
                        "type": "submission"
                    },
                    "links": {
                        "related": {
                            "href": "/submissions/cafd24c8-b2e5-44b6-87df-0190f0d3da74"
                        }
                    }
                },
                "actor": {
                    "data": {
                        "id": "9e30878b-265b-4455-9ee6-12ccc3288c2f",
                        "type": "identity"
                    },
                    "links": {
                        "related": {
                            "href": "(NOT IMPLEMENTED YET)"
                        }
                    }
                }
            },
            "links": {
                "self": "(NOT IMPLEMENTED YET)"
            }
        }
    ],
    "meta": {
        "total_hits": 1,
        "count": 1
    },
    "links": {
        "self": "/submissions/cafd24c8-b2e5-44b6-87df-0190f0d3da74/activities?include=actor,event",
        "next": "/submissions/cafd24c8-b2e5-44b6-87df-0190f0d3da74/activities?id=cafd24c8-b2e5-44b6-87df-0190f0d3da74&include=actor,event&page[limit]=25&page[offset]=25",
        "previous": "/submissions/cafd24c8-b2e5-44b6-87df-0190f0d3da74/activities?id=cafd24c8-b2e5-44b6-87df-0190f0d3da74&include=actor,event"
    }

Add `submission_comments` index endpoint

Added endpoint to query submission comments, this allow to get comments for a
specific submission and paginate them over the 100 on includable resources|
author and file_attachment can be included in the response 

{
    "data": [
        {
            "id": "82bcc1b8-147e-4f29-8f65-e92ab80130c2",
            "type": "comment",
            "attributes": {
                "body": "A comment",
                "created_at": "2025-04-23T16:49:14.797Z",
                "visibility_scope": "everyone"
            },
            "relationships": {
                "author": {
                    "data": {
                        "id": "49ceae08-148b-4d3b-a72f-876fd93b414a",
                        "type": "identity"
                    },
                    "links": {
                        "related": {
                            "href": "(NOT IMPLEMENTED YET)"
                        }
                    }
                },
                "file_attachments": {
                    "data": [],
                    "links": {
                        "related": {
                            "href": "(NOT IMPLEMENTED YET)",
                            "meta": {
                                "count": 0,
                                "total_hits": 0
                            }
                        }
                    }
                }
            },
            "links": {
                "self": "(NOT IMPLEMENTED YET)"
            }
        }
    ],
    "meta": {
        "total_hits": 1,
        "count": 1
    },
    "links": {
        "self": "/submissions/17420a17-29c2-46ef-9555-db3a3363a631/comments",
        "next": "/submissions/17420a17-29c2-46ef-9555-db3a3363a631/comments?id=17420a17-29c2-46ef-9555-db3a3363a631&page[limit]=25&page[offset]=25",
        "previous": "/submissions/17420a17-29c2-46ef-9555-db3a3363a631/comments?id=17420a17-29c2-46ef-9555-db3a3363a631"
    }
}

Remove pagination offset limit

Remove pagination offset limit, now the records can be paginated over the
10,000 previous limit   

New API version released 2025-02-25

2025-02-25T00:00:00+00:00

Add `access_invitation` create endpoint

Added endpoint to invite a user to the organization, the user will receive an invite email

{
    "data": {
        "type": "access_invitation",
        "attributes": {
          "grantee_email": "bugs@bugcrowd.com"
        },
        "relationships": {
          "organization": {
            "data": {
              "type": "organization",
              "id": "17d8d1bf-cd5d-4d46-8cb1-408b4f6a4ccf"
              }
            }
        }
    }
}

Add `access_invitation` delete endpoint

Added endpoint delete a pending access invitations

Add `access_invitations` index endpoint

Added endpoint to list all the pending access invitations

{
  "data": {
    "id": "022a09f2-ea89-4684-bbd1-b77ae8cd9830",
    "type": "access_invitation",
    "attributes": {
      "grantee_email": "bugs@bugcrowd.com",
      "created_at": "2022-11-13T00:00:00Z",
      "approved_at": null
    },
    "relationships": {
      "granting_identity": {
        "data": {
          "id": "641fae07-dbe4-4e8b-80ef-75eb157cefa8",
          "type": "identity"
        }
      },
      "organization": {
        "data": { 
          "id": "17d8d1bf-cd5d-4d46-8cb1-408b4f6a4ccf",
          "type": "organization"
        }
      },
      "resource_roles": {
        "data":  {
            "id": "17d8d1bf-cd5d-4d46-8cb1-408b4f6a4ccf",
            "type": "resource_role"
          }
      }


    }
  }
}

Add `member_role` update endpoint

Added endpoint to update the member role in the organization

{
  "data": {
    "type": "organization_member",
    "attributes": {
      "role": "member"
    }
  }
}
        

Add `multiple assignees` support to submission endpoints

Submission Index & Fetch APIs now returns an array of assignees in the response as an assignees relationships

{
  "data": {
    "id": "f40fa561-c434-43d2-8bb7-169adf9fc2eb",
    "type": "submission",
    "attributes": {
      "state": "new",
      "duplicate": true
    },
    "relationships": {
      "assignees": {
        "data": [
          {
            "type": "identity",
            "id": "061ba119-d315-4924-aa94-835b48a68ea7"
          }
        ]
      }
    }
  },
  "included": []
}

You can now pass an array of assignees to Submissions Update API to add multiple assignees to a submission. The previously stored assignees list will be replaced every time with the array of assignees that is passed into the request body.

{
  "data": {
    "type": "submission",
    "relationships": {
      "assignees": {
        "data": [
          {
            "type": "identity",
            "id": "061ba119-d315-4924-aa94-835b48a68ea7"
          },
          {
            "type": "identity",
            "id": "28f145f4-d2d1-4ca0-a696-096b03b3fde8"
          }
        ]
      }
    }
  }
}

Add `organization_member` delete endpoint

Added endpoint to delete an organization member, this will revokethe access to the organization

Add `organization_member` fetch endpoint

Added endpoint to fetch the data of a single organization member

    "data": {
    "id": "022a09f2-ea89-4684-bbd1-b77ae8cd9830",
    "type": "organization_member",
    "attributes": {
        "name": "Juan Zemlak",
        "email": "bounty-admin@redama.com"
    },
    "relationships": {
        "access_grants": {
            "data": [
                {
                    "id": "641fae07-dbe4-4e8b-80ef-75eb157cefa8",
                    "type": "member_access_grant"
                }
            ],
            "links": {
                "related": {
                    "href": "(NOT IMPLEMENTED YET)",
                    "meta": {
                        "count": 1,
                        "total_hits": 1
                    }
                }
            }
        }
    }
}
       

Add `organization_members` index endpoint

Added endpoint to list all the organization members

"data": [
    {
        "id": "022a09f2-ea89-4684-bbd1-b77ae8cd9830",
        "type": "organization_member",
        "attributes": {
            "name": "Juan Zemlak",
            "email": "bounty-admin@redama.com"
        },
        "relationships": {
            "access_grants": {
                "data": [
                    {
                        "id": "641fae07-dbe4-4e8b-80ef-75eb157cefa8",
                        "type": "member_access_grant"
                    }
                ],
                "links": {
                    "related": {
                        "href": "(NOT IMPLEMENTED YET)",
                        "meta": {
                            "count": 1,
                            "total_hits": 1
                        }
                    }
                }
            }
        }
    }
]

Add `program_role` create endpoint

Added endpoint to give a program roles to an organizatiopn member

{
    "data": {
        "type": "program_role",
        "attributes": {
            "role": "analyst"
        },
        "relationships": {
            "program": {
                "data": {
                    "type": "program",
                    "id": "17d8d1bf-cd5d-4d46-8cb1-408b4f6a4ccf"
                }
            },
            "user": {
                "data": {
                    "type": "user",
                    "id": "bbead996-7406-4901-8cd0-4cb2992b1343"
                }
            }
        }
    }
}

Add `program_role` delete endpoint

Added endpoint to revoke a program role

Add `program_roles` index endpoint

Added endpoint to display all program roles in an organization

    [
        {
        "id": "754adc54-6ba1-4396-8070-ad675301a7c6",
        "type": "program_role",
        "attributes": {
            "name": "Juan Zemlak",
            "email": "bounty-admin@redama.com",
            "program_name": "Redama Security",
            "program_code": "redama-security",
            "role": "admin"
        }
    }
]

Add `team` create endpoint

Added endpoint to create a team

{
  "data": {
    "type": "team",
    "attributes": {
      "name": "Team name 2",
      "description": "Team description"
    },
    "relationships": {
        "organization": {
        "data": {
          "type": "organization",
          "id": "c5e20746-9453-428f-afbf-0d5df92c5e7a"
        }
      }
    }
  }
}
        

Add `team` delete endpoint

Added endpoint to delete a team

Add `team` fetch endpoint

Added endpoint to list all the teams in the org

{
    "data":   {
            "id": "10000000-0000-0000-0000-000000000001",
            "type": "team",
            "attributes": {
                "name": "Team",
                "description": "Description"
            },
            "relationships": {
                "team_members": {
                    "data": [
                        {
                            "id": "10000000-0000-0000-0000-000000000001",
                            "type": "team_member"
                        }
                    ],
                    "links": {
                        "related": {
                            "href": "/teams/10000000-0000-0000-0000-000000000001/members",
                            "meta": {
                                "count": 1,
                                "total_hits": 1
                            }
                        }
                    }
                }
            }
        }
    ,
    "included": [
        {
            "id": "b5b7c6b2-03e4-4086-bf03-fcb37259c9dd",
            "type": "team_member",
            "attributes": {
                "name": "Buddy Stokes",
                "email": "joker@bugcrowd.com"
            },
            "relationships": {
                "team": {
                    "data": {
                        "id": "10000000-0000-0000-0000-000000000001",
                        "type": "team"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_hits": 1,
        "count": 1
    },
    "links": {
        "self": "/teams?include=team_members",
        "next": "/teams?include=team_members&page[limit]=25&page[offset]=25",
        "previous": "/teams?include=team_members"
    }
}
        

Add `team_member` delete endpoint

Added endpoint to delete a member from the team

Add `team_member` fetch endpoint

Added endpoint to fetch the data of a single team member

"data":  {
        "id": "022a09f2-ea89-4684-bbd1-b77ae8cd9830",
        "type": "team_member",
        "attributes": {
            "name": "Juan Zemlak",
            "email": "bugs@bugcrowd.com"
        },
        "relationships": {
            "access_grants": {
                "data": [
                    {
                        "id": "2f34827f-c0f1-4362-8428-33fee4f1d97a",
                        "type": "member_access_grant"
                    }
                ],
                "links": {
                    "related": {
                        "href": "(NOT IMPLEMENTED YET)",
                        "meta": {
                            "count": 3,
                            "total_hits": 3
                        }
                    }
                }
            }
        }
    }

Add `team_members` index endpoint

Added endpoint to list all the members of the team

"data": [
    {
        "id": "022a09f2-ea89-4684-bbd1-b77ae8cd9830",
        "type": "team_member",
        "attributes": {
            "name": "Juan Zemlak",
            "email": "bounty-admin@redama.com"
        },
        "relationships": {
            "access_grants": {
                "data": [
                    {
                        "id": "2f34827f-c0f1-4362-8428-33fee4f1d97a",
                        "type": "member_access_grant"
                    }
                ],
                "links": {
                    "related": {
                        "href": "(NOT IMPLEMENTED YET)",
                        "meta": {
                            "count": 3,
                            "total_hits": 3
                        }
                    }
                }
            }
        }
    },
    {
        "id": "a5807a88-f4ce-484d-bf52-0f7f2dc00b73",
        "type": "team_member",
        "attributes": {
            "name": "Georgine Moen",
            "email": "bounty-analyst@redama.com"
        },
        "relationships": {
            "access_grants": {
                "data": [
                    {
                        "id": "a7b07038-0eca-4d52-8986-c3a7d8ca5c2c",
                        "type": "member_access_grant"
                    }
                ],
                "links": {
                    "related": {
                        "href": "(NOT IMPLEMENTED YET)",
                        "meta": {
                            "count": 3,
                            "total_hits": 3
                        }
                    }
                }
            }
        }
    }
],
"meta": {
    "total_hits": 2,
    "count": 2
},
"links": {
    "self": "/teams/c87f211c-5ee7-4836-a009-c6c234cfe0d0/members",
    "next": "/teams/c87f211c-5ee7-4836-a009-c6c234cfe0d0/members?id=c87f211c-5ee7-4836-a009-c6c234cfe0d0&page[limit]=25&page[offset]=25",
    "previous": "/teams/c87f211c-5ee7-4836-a009-c6c234cfe0d0/members?id=c87f211c-5ee7-4836-a009-c6c234cfe0d0"
}

Add `team_role` create endpoint

Added endpoint to give a team and all it’s members access to a program

{
  "data": {
    "type": "team_role",
    "attributes": {
      "role": "admin"
    },
    "relationships": {
      "program": {
        "data": {
          "type": "program",
          "id": "UUID"
        }
      }
    }
  }
}

Add `team_role` delete endpoint

Added endpoint to revoke a team access to a program

Add `teams` index endpoint

Added endpoint to list all the teams in the org

{
    "data": [
        {
            "id": "10000000-0000-0000-0000-000000000001",
            "type": "team",
            "attributes": {
                "name": "Team",
                "description": "Description"
            },
            "relationships": {
                "team_members": {
                    "data": [
                        {
                            "id": "10000000-0000-0000-0000-000000000001",
                            "type": "team_member"
                        }
                    ],
                    "links": {
                        "related": {
                            "href": "/teams/10000000-0000-0000-0000-000000000001/members",
                            "meta": {
                                "count": 1,
                                "total_hits": 1
                            }
                        }
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "b5b7c6b2-03e4-4086-bf03-fcb37259c9dd",
            "type": "team_member",
            "attributes": {
                "name": "Buddy Stokes",
                "email": "joker@bugcrowd.com"
            },
            "relationships": {
                "team": {
                    "data": {
                        "id": "10000000-0000-0000-0000-000000000001",
                        "type": "team"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_hits": 1,
        "count": 1
    },
    "links": {
        "self": "/teams?include=team_members",
        "next": "/teams?include=team_members&page[limit]=25&page[offset]=25",
        "previous": "/teams?include=team_members"
    }
}
        

New API version released 2024-08-15

2024-08-15T00:00:00+00:00

Add `engagement` relationship to submission creation endpoint

Added engagement relationship to submission creation. Now you can create a submission with an engagement.

{
  "data": {
    "type": "submission",
    "attributes": {
      "title": "This is a good title",
      "description": "This contains a POC"
    },
    "relationships": {
      "engagement": {
        "data": {
          "type": "engagement",
          "id": "4d7925b2-cfb1-4399-b08b-486699696860"
        }
      },
        "program": {
        "data": {
          "type": "program",
          "id": "ca64f761-8881-4481-bc15-915b36940002"
        }
      }

    }
  }
}

New API version released 2024-07-11

2024-07-11T00:00:00+00:00

A set of API endpoints provides enterprise customers audit capabilities to support their GRC policies. Utilizing the audit log API endpoints, the Organization Owner can request the following information for a specific duration from their organization users.

Note: Only the last 30 days worth of logs are available for retrieval.

Add `authentication log` endpoint

Logs to track user log in and log out, and denied log in activities.

"data": [
  {
    "time": "2021-08-01T00:00:00Z",
    "actor": "email@example.com",
    "action": "Logged In|Logged Out",
    "ip_address": "192.168.10.1",
    "reason": "Authentication Denied"
  }

Add `authorization logs` endpoint

Logs to track user provisioning, de-provisioning, and role assignment and change activities for an organization and a program.

"data": [
  {
    "time": "2021-08-01T00:00:00Z",
    "actor": "email@example.com -> user that actions permission change",
    "object": "email-2@example.com -> User that receives permission change",
    "action": "Added|Removed",
    "attribute": "org-owner|admin|analyst|viewer",
    "resource": "Organization: Redama LLC|Program: Redama VDP"
  }

Add `disclosure request` endpoint

A set of API endpoints allows an Organization Owner to request the details from a set of submissions that have Disclosure Requests. This helps the organization automate the workflow and respond faster to Disclosure Requests.

"data": [
    {
      "status": "approved|denied|requested",
      "disclosure_level": "limited|full",
      "created_at": "2021-08-01T00:00:00Z",
      "responded_at": "2021-08-01T00:00:00Z",
      "approved_by_id": "email-2@example.com",
      "submission_id": "01f98d72-cb21-4a61-8515-70ecc76e3881"
    }
  }

New API version released 2024-03-27

2024-03-27T00:00:00+00:00

Add `activities.event` as includable resource to submission endpoint

Added event data as an includable resource to the submission endpoint, now can be query by using

include=activities.event on the query parameters

"data": [
  "id": "54239bf3-59c2-45d3-b3c6-77414b24422e",
  "type": "event",
  "attributes": {
      "created_at": "2024-03-20T00:05:03.259Z",
      "key": "submission.updated.transitioned",
      "data": {
          "changes": {
              "substate": {
                  "to": "triaged",
                  "from": "not_reproducible"
              }
          },
          "duplicate_ids": []
      }
  }

Add filter by `engagement` to `submission` endpoint

Now the submissions can be filtered by engagement code filter[engagement]=engagement-code ```

Add `submissions` as includable resource to engagement endpoint

Added submissions as an includable resource to the engagement endpoint, now can be query by using

include=submissions on the query parameters

New API version released 2024-02-12

2024-02-12T00:00:00+00:00

Release `engagement` resource endpoint

Added a new endpoint for querying Engagements. We removed the program brief references and replaced them with the engagement_brief resource.

"data": [
    {
        "id": "1125fcf9-7439-4110-8815-44baaa24d7e4",
        "type": "engagement",
        "attributes": {
            "id": "1125fcf9-7439-4110-8815-44baaa24d7e4",
            "cancellation_reason": null,
            "code": "redama-pentest",
            "ends_at": "2024-03-09T00:00:00.000Z",
            "expected_completed_at": "2024-04-09T00:00:00.000Z",
            "last_transition_at": null,
            "paused_reason": null,
            "starts_at": "2024-01-09T00:00:00.000Z",
            "state": "in_progress",
            "created_at": "2024-01-09T00:44:03.524Z",
            "updated_at": "2024-01-17T17:38:35.127Z"
        },
        "relationships": {
            "bounty": {
                "data": {
                    "id": "da1ac64d-3ada-4895-8340-f961a28e6a62",
                    "type": "program"
                },
                "links": {
                    "related": {
                        "href": "(NOT IMPLEMENTED YET)"
                    }
                }
            }
        }
    }
]

Customer > Platform > Delete Outgoing Webhook

2023-07-04T00:00:00+00:00

Support for outgoing webhooks has been improved with the ability to delete a webhook and its recent deliveries.

View Team Member API Keys

2022-04-28T00:00:00+00:00

Admins can view the API keys being used by their team members and revoke the tokens as required. This is currently available for Organization Owner roles on Bugcrowd and applies to the current and future use of the Bugcrowd API.

Deprecation of Generic Header Usage for Legacy (v3) API

2022-03-08T00:00:00+00:00

Previously the legacy (v3) API version would support generic Accept headers: application/vnd.bugcrowd+json and application/json.

We have deprecated usage of generic accept header for legacy (v3) API. If you are using the legacy (v3) API version, it is recommended to start using the full versioned Accept header: application/vnd.bugcrowd+v3.json.

To interact with the legacy (v3) API, the token must be pinned to the Legacy version.

For information about how to use the Accept headers, see accept header.

Bugcrowd Docs | Changelogs | Api_webhook

Introducing New API Versioning System

Transforming Bugcrowd API Architecture for a Better Developer Experience

Consolidation of Versions

Versioning and API Keys

Next Steps

New API version released 2025-04-23

Add submission_activities index endpoint

Add submission_comments index endpoint

Remove pagination offset limit

New API version released 2025-02-25

Add access_invitation create endpoint

Add access_invitation delete endpoint

Add access_invitations index endpoint

Add member_role update endpoint

Add multiple assignees support to submission endpoints

Add organization_member delete endpoint

Add organization_member fetch endpoint

Add organization_members index endpoint

Add program_role create endpoint

Add program_role delete endpoint

Add program_roles index endpoint

Add team create endpoint

Add team delete endpoint

Add team fetch endpoint

Add team_member delete endpoint

Add team_member fetch endpoint

Add team_members index endpoint

Add team_role create endpoint

Add team_role delete endpoint

Add teams index endpoint