New API version released 2025-02-25

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"
    }
}