Go Contacts HTTP API¶
This API is to be used to gain access to Contact and Group data within Vumi Go.
The API is indended to cover the following parts of the Vumi Go functionality:
- Contacts/Groups
- Get one
- Get all
- Create one
- Update one
- Delete one
Request responses and bodies are all encoded in JSON, with the exception of errors. Streaming requests are encoded in newline separated JSON.
Contents¶
Response Format Overview¶
API Authentication¶
Authentication is done using an OAuth 2.0 bearer token.
Example request:
GET /api/contacts/ HTTP/1.1
Host: example.com
Authorization: Bearer auth-token
Example response (success):
HTTP/1.1 200 OK
{"cursor": null, "data": []}
Example response (failure):
HTTP/1.1 403 Forbidden
Example response (no authorization header):
HTTP/1.1 401 Unauthorized