List Messaging Contacts

Beta

GET/v1/messaging/contacts

This endpoint is idempotent. Learn more

Lists the caller's messageable contacts.

Permissions requiredValues:messaging:read

The role behind your API key or agent must grant every one of these permissions.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:role

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of actor

Resources in this page.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

roleroleExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

admin: full administrative access, including managing API keys.
user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
scanner: a role for scanning-station operators.
sales_rep: a role for sales representatives.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

Always returned as null in this endpoint.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Messaging Contacts

List Messaging Contacts

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listActor = await client.messaging.retrieveContacts();

console.log(listActor.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listActor = await client.messaging.retrieveContacts();

console.log(listActor.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/contacts?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidXNfMDE1MTE2NGRjYWVhNGNiZGVkMjdiNTBhYWUiLCJkIjoiZiJ9.AlwHbJzG8ZzxjZgaocwP6lUPWlQWCzAoZLlGmx6SxHE",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "us_0151164dcaea4cbded27b50aae",
      "object": "actor",
      "type": "user",
      "name": "John Doe",
      "handle": "jdoe@augno.com",
      "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
      "role": {
        "id": "rl_01c16d2eb637c0d1f3a372937c",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": null,
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/contacts?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidXNfMDE1MTE2NGRjYWVhNGNiZGVkMjdiNTBhYWUiLCJkIjoiZiJ9.AlwHbJzG8ZzxjZgaocwP6lUPWlQWCzAoZLlGmx6SxHE",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "us_0151164dcaea4cbded27b50aae",
      "object": "actor",
      "type": "user",
      "name": "John Doe",
      "handle": "jdoe@augno.com",
      "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
      "role": {
        "id": "rl_01c16d2eb637c0d1f3a372937c",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": null,
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    }
  ]
}

List Messaging Contacts

Authorization

Query Parameters

Returns

Responses