List Blocks

Beta

GET/v1/messaging/blocks

This endpoint is idempotent. Learn more

Lists the caller's messaging blocks.

Permissions requiredValues:messaging:read

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

include[]optional arrayenumValues:blocked_userblocked_user.userblocked_user.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 messaging_block

Resources in this page.

idstring

Block ID.

objectstringenumValues:messaging_block

Resource type identifier.

blocked_useraccount_userExpandablenullable

The blocked account user.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

active: the user can access the account.
disabled: the user is locked out of the account.
removed: the user has been removed (soft-deleted) from the account.

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.

departmentdepartmentExpandablenullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationnullable

The storage location where this department operates.

Always returned as null in this endpoint.

scanning_stationslistnullable

Scanning stations in this department.

Always returned as null in this endpoint.

machineslistnullable

Machines in this department.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

useruserExpandablenullable

Underlying user.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address.

namestringnullable

User's full display name.

usernamestringnullable

Username.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

URL of the user's profile image.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

created_atstring (date-time)

When the block was created.

Responses

200

Successful response for List Blocks

List Blocks

import Augno from '@augno/sdk';

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

const listMessagingBlock = await client.messaging.blocks.list();

console.log(listMessagingBlock.data);

import Augno from '@augno/sdk';

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

const listMessagingBlock = await client.messaging.blocks.list();

console.log(listMessagingBlock.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/blocks?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibWdia18wMWg5ejhxMXcyZTNyNHQ1eTZtZ2JrIiwiZCI6ImYifQ.ltp3w9KqrZHkH-1NFwnY5UbZbJZUaSlogLreuZcqHjU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "mgbk_01h9z8q1w2e3r4t5y6mgbk",
      "object": "messaging_block",
      "blocked_user": null,
      "created_at": "2026-05-10T00:00:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/blocks?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibWdia18wMWg5ejhxMXcyZTNyNHQ1eTZtZ2JrIiwiZCI6ImYifQ.ltp3w9KqrZHkH-1NFwnY5UbZbJZUaSlogLreuZcqHjU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "mgbk_01h9z8q1w2e3r4t5y6mgbk",
      "object": "messaging_block",
      "blocked_user": null,
      "created_at": "2026-05-10T00:00:00Z"
    }
  ]
}

List Blocks

Authorization

Query Parameters

Returns

Responses