---
title: "v1 Pull and acknowledge messages from a queue"
slug: "pull-and-acknowledge-messages-from-a-queue"
updated: 2024-03-26T16:37:23Z
published: 2024-03-26T16:37:23Z
canonical: "help.rapididentity.com/pull-and-acknowledge-messages-from-a-queue"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.rapididentity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# v1 Pull and acknowledge messages from a queue

Post/v1/tenants/{tenantId}/projects/{projectId}/subscriptions/{sub}:pull

Pull and acknowledge messages from a queue

SecurityAPI KeyHeader parameter nameAuthorization

AWS Cognito Authorizer. Since there are no custom scopes the ID Token must be used for authorization

Path parameterstenantIdstringRequired

The RapidIdentity Cloud tenant id

projectIdstringRequired

The project id this service belongs. MUST be builtin or custom

substringRequired

The queue name.

Body parameters

The number of messages to pull from the queue.

<select class='api-response-data'><option value='af10bca8-eca5-4b62-b697-1b96e145d3d7'>application/json</option>
</select><select class='select-example'><option value='113c64d0-a83a-4511-a5e8-eb47d43939a3'>maxMessagesExample</option>
</select>maxMessagesExample

Retrieving up to 5 messages from queue

```json
{
  "maxMessages": 5
}
```

objectmaxMessagesinteger  Required

The maximum number of messages to return from this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified

Responses200

An array of messages from the queue or nil

<select class='api-response-data'><option value='982c8799-b913-4cdd-9ba9-4f926a21421a'>application/json</option>
</select>Expand AllOneOfPullSuccessBodyreceivedMessages Array of object (PubsubMessageV1) objectdatastring  
messageIdstring  
publishTimestring  

SuccessBodysuccessstring  

PullLogSuccessBodyreceivedMessages Array of objectobject

400

Body is not present or formatted incorrectly

<select class='api-response-data'><option value='e8764cbe-99e1-4317-ba07-8d877cac9697'>application/json</option>
</select>objecterrorstring  

403

The request is not authorized. Check that an api key exists and that the api key is valid for the tenantId

<select class='api-response-data'><option value='7a27a7b1-0552-4dc3-8afa-45276d65b88f'>application/json</option>
</select>objecterrorstring  

500

Unable to retrieve queue as name does not exist

<select class='api-response-data'><option value='e143d35c-e869-40b3-8a7a-9848142663d0'>application/json</option>
</select>objecterrorstring  

501

The request does not have a projectId of custom or builtin

<select class='api-response-data'><option value='6c3036db-dd69-4aca-89af-61b9747beb7e'>application/json</option>
</select>objecterrorstring  

503

Unable to connect to pubsub service

<select class='api-response-data'><option value='35c87a67-c1f8-4c4b-aee5-db9deae21f3d'>application/json</option>
</select>objecterrorstring