How to Find Resource IDs

All API requests require a Team ID and some require other resource IDs.

This article will help you quickly find the necessary IDs to start making API requests.

Team IDs

A Team ID is a required path parameter for all API requests. For example, in the following API endpoint, {team} should be replaced with the appropriate Team ID.

GET https://vamp.bot/api/teams/{team}/guides

To access the desired Team ID, first log in to Vamp and switch to the Team you would like to make API requests for under Your teams in the left-hand navigation menu.

Next, navigate to Team settings by selecting the Team link in the left-hand navigation menu.

You may now retrieve your Team ID from the address bar in your browser. The ID follows teams/ in the URL.

https://vamp.bot/teams/YOUR_TEAM_ID

Select the Team ID with your cursor and copy it.

Guide IDs

A Guide ID is needed to get, update, and delete a Guide.

From the Browser

To access the desired Guide ID, first log in to Vamp and navigate to Guides by selecting the Guides link in the left-hand navigation menu.

Next, select your desired Guide from the list to navigate to its detail page.

You may now retrieve your Guide ID from the address bar in your browser. The ID follows guides/ in the URL.

https://vamp.bot/guides/YOUR_GUIDE_ID

Select the Guide ID with your cursor and copy it.

From the API

You can also retrieve Guide IDs using the Vamp API by making a request to the List Guides endpoint.

GET https://vamp.bot/api/teams/{team}/guides

The Guides will be returned as an array under the data key. The Guide object includes many details, including the Guide ID.

{
  "data": [
    {
      "id": "string",
      "name": "string",
      ...
    },
    ...
  ],
  ...
}

Interview IDs

An Interview ID is needed to get an Interview.

You can retrieve Interview IDs using the Vamp API by making a request to the List Interviews endpoint.

GET https://vamp.bot/api/teams/{team}/guides/{guide}/interviews

The Interviews will be returned as an array under the data key. The Interview object includes many details, including the Interview ID.

{
  "data": [
    {
      "id": "string",
      "completed_at": "string",
      ...
    },
    ...
  ],
  ...
}

Demo IDs

A Demo ID is needed to get a Demographic.

You can retrieve Demo IDs using the Vamp API by making a request to the List Demographics endpoint.

GET https://vamp.bot/api/teams/{team}/demos

The Demos will be returned as an array. The Demo object includes an ID and label.

[
  {
    "id": "string",
    "label": "string"
  },
  ...
]