Open App

Funding

API endpoints for funding

List funding directory entries

GET /api/v1/funding

Parameters

NameInTypeRequiredDescription
organisationIdquerystringNo
searchquerystringNo
countryquerystringNo
typeIdquerystringNo
rolodexIdquerystringNo
containerIdquerystringNo
pillarIdquerystringNo
limitqueryintegerNo

Example request

curl -X GET \
"https://api.example.com/api/v1/funding?organisationId=<organisationId>&search=<search>&country=<country>&typeId=<typeId>&rolodexId=<rolodexId>&containerId=<containerId>&pillarId=<pillarId>&limit=<limit>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "country": "string",
      "decisionTime": "string",
      "eligibility": "string",
      "website": "string",
      "deadline": 0,
      "phone": "string",
      "email": "string",
      "description": "string",
      "userId": "string",
      "organisationId": "string",
      "createdAt": 0,
      "updatedAt": 0
    }
  ]
}

Response body type

{ data: Funding[] }


Create funding directory entry

POST /api/v1/funding

Example request

curl -X POST \
"https://api.example.com/api/v1/funding" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","country":"string","decisionTime":"string","eligibility":"string","website":"string","deadline":0,"phone":"string","email":"string","description":"string","organisationId":"string","typeIds":["string"],"rolodexIds":["string"],"containerIds":["string"],"pillarIds":["string"]}'

Response body type


Get funding directory entry

GET /api/v1/funding/{id}

Parameters

NameInTypeRequiredDescription
idpathstringYesPath parameter.

Example request

curl -X GET \
"https://api.example.com/api/v1/funding/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "country": "string",
    "decisionTime": "string",
    "eligibility": "string",
    "website": "string",
    "deadline": 0,
    "phone": "string",
    "email": "string",
    "description": "string",
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0
  }
}

Response body type

{ data: Funding }


Update funding directory entry

PATCH /api/v1/funding/{id}

Parameters

NameInTypeRequiredDescription
idpathstringYesPath parameter.

Example request

curl -X PATCH \
"https://api.example.com/api/v1/funding/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","country":"string","decisionTime":"string","eligibility":"string","website":"string","deadline":0,"phone":"string","email":"string","description":"string"}'

Response body type


Delete funding directory entry

DELETE /api/v1/funding/{id}

Parameters

NameInTypeRequiredDescription
idpathstringYesPath parameter.

Example request

curl -X DELETE \
"https://api.example.com/api/v1/funding/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type