API Requests

Zappier can also be leveraged to directly connect GovTribe to your API's. The following provides a list of API requests we support.

API Requests

Required Headers

All requests should include these headers:

Authorization: Bearer YOUR_GOVTRIBE_ZAPIER_API_KEY
Content-Type: application/json
Accept: application/json

Auth Test

This endpoint tests the validity of the provided API key.

Request

POST /api/zapier/auth-test

Response

200 OK

Returns a JSON object containing the authenticated user's ID, name, and email address.

Example Response

{
    "id": "66f70adf61275a2069065f61",
    "name": "GovTribe User",
    "email": "[email protected]"
}

Webhook Subscription - Create

Create a Zapier Webhook Subscription.

Request

POST /api/zapier/webhook-subscription

{
    "event": "new_result_for_saved_search",
    "saved_search_model_id": "66f55bc64b8b9d6b840396e8"
}

Response

201 CREATED

Returns a Zapier Webhook Subscription.

Webhook Subscription - Delete

Create a Zapier Webhook Subscription.

Request

DELETE /api/zapier/webhook-subscription/{id}

Response

200 OK

{
    "deleted": true
}

Federal Contract Opportunity - List

Returns a list of Federal Contract Opportunity Resources. Provide an optional saved_search_model_id to filter the results.

Request

GET /api/zapier/federal-contract-opportunity

{
    "saved_search_model_id": "66f55bc64b8b9d6b840396e8"
}

Response

200 OK

[
  {
    "id": "c119c6fc-5ce3-4fc6-bf5d-0c8d63bd7015",
    "name": "Federal Contract Opportunity 1",
    // Additional fields...
  },
  // More opportunities...
]

Federal Contract Opportunity - Get

Returns a single hydrated Federal Contract Opportunity Resources.

Request

GET /api/zapier/federal-contract-opportunity/{id}

Response

200 OK

{
    "id": "c119c6fc-5ce3-4fc6-bf5d-0c8d63bd7015",
    "name": "Federal Contract Opportunity 1",
    // Additional fields...
}

Federal Contract Award - List

Returns a list of Federal Contract Award Resource. Provide an optional saved_search_model_id to filter the results.

Request

GET /api/zapier/federal-contract-award

{
    "saved_search_model_id": "66f55bc64b8b9d6b840396e8"
}

Response

200 OK

[
  {
    "id": "c119c6fc-5ce3-4fc6-bf5d-0c8d63bd7015",
    "name": "Federal Contract Award 1",
    // Additional fields...
  },
  // More opportunities...
]

Federal Contract Award- Get

Returns a single hydrated Federal Contract Award Resource.

Request

GET /api/zapier/federal-contract-award/{id}

Response

200 OK

{
    "id": "c119c6fc-5ce3-4fc6-bf5d-0c8d63bd7015",
    "name": "Federal Contract Award 1",
    // Additional fields...
}

Federal Contract IDV - List

Returns a list of Federal Contract IDV Resources. Provide an optional saved_search_model_id to filter the results.

Request

GET /api/zapier/federal-contract-idv

{
    "saved_search_model_id": "67902c7d7038e143aa085322"
}

Response

200 OK

[
  {
    "id": "c119c6fc-5ce3-4fc6-bf5d-0c8d63bd7015",
    "name": "Federal Contract IDV 1",
    // Additional fields...
  },
  // More contract IDVs...
]

Federal Contract IDV - Get

Returns a single hydrated Federal Contract IDV Resource.

Request

GET /api/zapier/federal-contract-idv/{id}

Response

200 OK

{
  "id": "c119c6fc-5ce3-4fc6-bf5d-0c8d63bd7015",
  "name": "Federal Contract IDV 1",
  // Additional fields... 
}

Federal Grant Opportunity - List

Returns a single hydrated Federal Grant Opportunity Resources. Provide an optional saved_search_model_id to filter the results.

Request

GET /api/zapier/federal-grant-opportunity

{
    "saved_search_model_id": "66f55bc64b8b9d6b840396e8"
}

Response

200 OK

[
  {
    "id": "345209-F",
    "name": "Federal Grant Opportunity 1",
    // Additional fields...
  },
  // More opportunities...
]

Federal Grant Opportunity - Get

Returns a single hydrated Federal Grant Opportunity.

Request

GET /api/zapier/federal-grant-opportunity/{id}

Response

200 OK

{
    "id": "345209-F",
    "name": "Federal Grant Opportunity 1",
    // Additional fields...
}

Federal Grant Award - List

Returns a list of Federal Grant Award Resources. Provide an optional saved_search_model_id to filter the results.

Request

GET /api/zapier/federal-grant-award

{
    "saved_search_model_id": "66f55bc64b8b9d6b840396e8"
}

Response

200 OK

[
  {
    "id": "AIDFFPG1100062",
    "name": "Federal Grant Award 1",
    // Additional fields...
  }
  // More opportunities...
}

Federal Grant Award - Get

Returns a single hydrated Federal Grant Award Resource.

Request

GET /api/zapier/federal-grant-award/{id}

Response

200 OK

{
    "id": "AIDFFPG1100062",
    "name": "Federal Grant Award 1",
    // Additional fields...
{

Federal Forecast - List

Returns a list of Federal Forecast Resources. Provide an optional saved_search_model_id to filter the list.

Request

GET /api/zapier/federal-forecast

{
    "saved_search_model_id": "65778750fc0f437422012b12"
}

Response

200 OK

[
  {
    "id": "65778750fc0f437422012b12",
    "name": "Federal Forecast 1",
    // Additional fields...
  },
  // More forecasts...
]

Federal Forecast - Get

Returns a single hydrated Federal Forecast Resource.

Request

GET /api/zapier/federal-forecast/{id}

Response

200 OK

{
    "id": "65778750fc0f437422012b12",
    "name": "Federal Forecast 1"
    // Additional fields...
}

State and Local Contract Opportunity - List

Returns a list of State and Local Contract Opportunity Resources. Provide an optional saved_search_model_id to filter the results.

Request

GET /api/zapier/state-local-contract-opportunity

{
    "saved_search_model_id": "66f55bc64b8b9d6b840396e8"
}

Response

200 OK

[
  {
    "id": "65f49c390c6a1c87ae063840",
    "name": "Media Monitoring Suite ( Public Info)",
    // Additional fields...
  },
  // More opportunities...
]

State and Local Contract Opportunity - Get

Returns a single hydrated State and Local Contract Opportunity Resource.

Request

GET /api/zapier/state-local-contract-opportunity/{id}

Response

200 OK

{
    "id": "65f49c390c6a1c87ae063840",
    "name": "Media Monitoring Suite ( Public Info)",
    // Additional fields...
}

Pipeline - List

Returns a list of Pipeline Resources the user has access to.

Request

GET /api/zapier/pipeline

Response

200 OK

[
  {
    "id": "66f70adf61275a2069065f63",
    "name": "Pipeline 1",
    // Additional fields...
  },
  // More opportunities...
]

Pipeline - Get

Returns a single hydrated Pipeline Resource.

Request

GET /api/zapier/pipeline/{id}

Response

200 OK

{
    "id": "66f70adf61275a2069065f63",
    "name": "Pipeline 1",
    // Additional fields...
}

Stage - List

Returns a list of Stage Resources the user has access to.

Request

GET /api/zapier/stage

Response

200 OK

[
  {
    "id": "66f70bba3b1a2d4e09061a36",
    "name": "Won",
    // Additional fields...
  },
  // More opportunities...
]

Stage - Get

Returns a single hydrated Stage Resource.

Request

GET /api/zapier/stage/{id}

Response

200 OK

{
    "id": "66f70bba3b1a2d4e09061a36",
    "name": "Won",
    // Additional fields...
}

Pursuit - List

Returns a list of Pursuit Resources the user has access to.

Request

GET /api/zapier/pursuit

Response

200 OK

[
  {
    "id": "66f70b7665db93f2b90ab6e7",
    "name": "Pursuit",
    // Additional fields...
  },
  // More opportunities...
]

Pursuit - Get

Returns a single hydrated Pursuit Resource.

Request

GET /api/zapier/pursuit/{id}

Response

200 OK

{
    "id": "66f70b7665db93f2b90ab6e7",
    "name": "Pursuit",
    // Additional fields...
}