Users

Get data harvest status

Retrieves detailed status information for a specific data harvest. Shows progress, completion status, and other metadata about the harvest request.

get/users/@me/harvest/{harvestId}

Path parameters

string snowflake required

integer required

The ID of the harvest request

Response

Success

harvest_idstring snowflake required

status'pending' | 'processing' | 'completed' | 'failed' required

Current status of the harvest request

created_atstring required

ISO 8601 timestamp when the harvest request was created

started_atstring nullable required

ISO 8601 timestamp when the harvest started, or null if pending

completed_atstring nullable required

ISO 8601 timestamp when the harvest completed, or null otherwise

failed_atstring nullable required

ISO 8601 timestamp when the harvest failed, or null otherwise

file_sizestring nullable required

Final file size of the downloaded data, expressed as a string, or null if not available

progress_percentnumber required

Harvest progress as a percentage value between 0 and 100

progress_stepstring nullable required

Textual description of the current harvest step, if available

error_messagestring nullable required

Error message when the harvest fails, or null otherwise

download_url_expires_atstring nullable required

ISO 8601 timestamp when the download URL expires, or null if unavailable

expires_atstring nullable required

ISO 8601 timestamp when the harvest download expires, or null if unavailable

Changes

Changed in 4 of the 21 revisions of this API.83232

Sep 18, 2026dd0ad4ea1c8888See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ○
  response property completed_at list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property download_url_expires_at list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property error_message list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property expires_at list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property failed_at list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property file_size list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property progress_step list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property started_at list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
Sep 6, 2026a52a2cf49d9b32See the full diff
- ●
  added the new IP_BAN_DECLINED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new IP_BAN_DECLINED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new IP_BAN_DECLINED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new IP_BAN_DECLINED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Sep 5, 20264dbb738a3e224See the full diff
- ○
  removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status
  response-property-enum-value-removed
Sep 3, 2026fa36b1b48ca520See the full diff
- ○
  removed the INVALID_PACK_TYPE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_PACK_TYPE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_PACK_TYPE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID_PACK_TYPE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACKS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACKS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACKS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACKS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PACK_ACCESS_DENIED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PACK_ACCESS_DENIED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PACK_ACCESS_DENIED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PACK_ACCESS_DENIED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the UNKNOWN_PACK enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the UNKNOWN_PACK enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the UNKNOWN_PACK enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the UNKNOWN_PACK enum value from the response property for the response status
  response-property-enum-value-removed
This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 21 revisions, 2 have no diff computed.

Full history