Get request

GET 
/v2/request-queues/:queueId/requests/:requestId

Returns request from queue.

Request

Path Parameters

queueId string required
Queue ID or username~queue-name.

Example: WkzbQMuFYuamGv3YF
requestId string required
Request ID.

Example: xpsmkDlspokDSmklS

Status 200

Response Headers

{
  "data": {
    "uniqueKey": "GET|60d83e70|e3b0c442|https://apify.com",
    "url": "https://apify.com",
    "method": "GET",
    "retryCount": 0,
    "loadedUrl": "https://apify.com/jobs",
    "payload": null,
    "headers": null,
    "userData": {
      "label": "DETAIL",
      "image": "https://picserver1.eu"
    },
    "noRetry": false,
    "errorMessages": null,
    "handledAt": "2019-06-16T10:23:31.607Z",
    "id": "sbJ7klsdf7ujN9l"
  }
}

Schema

• data object required

  A request stored in the request queue, including its metadata and processing state.

  • uniqueKey UniqueKey (string) required

    A unique key used for request de-duplication. Requests with the same unique key are considered identical.

    
    Example: GET|60d83e70|e3b0c442|https://apify.com
  • url string<uri> required

    The URL of the request.

    
    Example: https://apify.com
  • method HttpMethod (string)

    Possible values: [GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH]

    
    Example: GET
  • retryCount RetryCount (integer)

    The number of times this request has been retried.

    
    Example: 0
  • loadedUrl string,null<uri> nullable

    The final URL that was loaded, after redirects (if any).

    
    Example: https://apify.com/jobs
  • payload object | null nullable

    The request payload, typically used with POST or PUT requests.

    
    Example: null
  • headers object | null nullable

    HTTP headers sent with the request.

    
    Example: null
  • userData object

    Custom user data attached to the request. Can contain arbitrary fields.

    • label string | null nullable

      Optional label for categorizing the request.

      
      Example: DETAIL
    • image string,null<uri> nullable

      Optional image URL associated with the request.

      
      Example: https://picserver1.eu
    • property name* any

      Custom user data attached to the request. Can contain arbitrary fields.

  • noRetry boolean | null nullable

    Indicates whether the request should not be retried if processing fails.

    
    Example: false
  • errorMessages string[] nullable

    Error messages recorded from failed processing attempts.

    
    Example: null
  • handledAt string,null<date-time> nullable

    The timestamp when the request was marked as handled, if applicable.

    
    Example: 2019-06-16T10:23:31.607Z
  • id RequestId (string) required

    A unique identifier assigned to the request.

    
    Example: sbJ7klsdf7ujN9l

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 401

Unauthorized - authentication required or invalid token.

{
  "error": {
    "type": "token-not-valid",
    "message": "Authentication token is not valid."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 403

Forbidden - insufficient permissions to perform this action.

{
  "error": {
    "type": "permission-denied",
    "message": "You do not have permission to perform this action."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 404

Not found - the requested resource was not found.

{
  "error": {
    "type": "record-not-found",
    "message": "Request Queue was not found"
  }
}

Schema

oneOf
• RequestQueueNotFoundError
• RequestNotFoundError
error object
• type string

  Possible values: [record-not-found]

• message string
  Example: Request Queue was not found

Status 405

Method not allowed.

{
  "error": {
    "type": "method-not-allowed",
    "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 429

Too many requests - rate limit exceeded.

{
  "error": {
    "type": "rate-limit-exceeded",
    "message": "You have exceeded the rate limit. Please try again later."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)