Rolodex

List rolodex directory entries

GET /api/v1/rolodex

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`search`	query	string	No	—
`country`	query	string	No	—
`typeId`	query	string	No	—
`categoryId`	query	string	No	—
`containerId`	query	string	No	—
`pillarId`	query	string	No	—
`limit`	query	integer	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/rolodex?organisationId=<organisationId>&search=<search>&country=<country>&typeId=<typeId>&categoryId=<categoryId>&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",
      "address": "string",
      "website": "string",
      "phone": "string",
      "description": "string",
      "userId": "string",
      "organisationId": "string",
      "createdAt": 0,
      "updatedAt": 0
    }
  ]
}

Response body type

{ data: Rolodex[] }

Create rolodex directory entry

POST /api/v1/rolodex

Example request

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

Response body type

—

Get rolodex directory entry

GET /api/v1/rolodex/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

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

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "country": "string",
    "address": "string",
    "website": "string",
    "phone": "string",
    "description": "string",
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0
  }
}

Response body type

{ data: Rolodex }

Update rolodex directory entry

PATCH /api/v1/rolodex/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

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

Response body type

—

Delete rolodex directory entry

DELETE /api/v1/rolodex/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

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

Response body type

—