Look up contacts on Cowdi
Match the caller's address-book phone numbers against Cowdi users in the acting organization. Returns only the numbers that belong to a Cowdi user in that organization. Other numbers are omitted from the response. Requires an authenticated, active user.
Authorization
oauth2 Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.
In: header
Request Body
application/json
Phone numbers from the user's address book to match against Cowdi users
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/user/payees/lookup" \ -H "Content-Type: application/json" \ -d '{ "mobile_numbers": [ "254712345678", "254700000000" ] }'[ { "mobile_number": "254712345678", "user_tag": "@johnd123456", "display_name": "John Doe" }]{ "code": "BAD_REQUEST", "description": "Bad Request"}{ "code": "UNAUTHORISED", "description": "Unauthorised"}{ "code": "FORBIDDEN", "description": "Forbidden"}{ "code": "RATE_LIMIT_EXCEEDED", "description": "Too Many Requests"}{ "code": "INTERNAL_ERROR", "description": "Internal Server Error"}Get payees by id POST
Get the caller's payees for a list of ids, in the order requested. The response omits any id that does not exist or does not belong to the caller. It never returns 404 for a missing id. Accepts 1 to 100 ids per request. Requires an authenticated, active user.
Get a payee GET
Get one of the caller's payees, with all of its accounts. Requires an authenticated, active user. Returns 404 when the payee does not exist or does not belong to the caller.