Skip to Content
WalidoDocs
Public APIGroups

List groups

GET
/groups

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the Walido dashboard (Settings → API Keys).

Query Parameters

cursor?string

Opaque cursor from a prior meta.next_cursor. Base64url-encoded (unpadded) - do not parse or construct it manually. A value that is not base64url is rejected with validation_failed, and so is a /phone-numbers cursor without a phone number; any other value that does not decode to a list position (a timestamp and a row id) restarts at the first page.

Match^[A-Za-z0-9_-]+$
limit?integer

Items per page (1–200, default 50).

Range1 <= value <= 200
Default50
type?string

Filter by group type.

Value in"contacts""knowledges""forwardings""glossaries""pronunciations"

Response Body

Page of groups.

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://api.walido.it/api/v1/groups'
Example Response
{  "data": [    {      "id": "string",      "type": "contacts",      "name": "string",      "description": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "has_more": true,    "next_cursor": "string"  }}