Sign inGet Started

List Apple Messages for Business submissions

GET
/v1/amb/business-accounts/{business_account_id}/submissions
const result = await bird.amb.businessAccounts.submissions.list(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
  { limit: 2 },
);
console.log(result);
Risposta200
{
  "data": [
    {
      "id": "abs_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "readiness_attachment": {
        "created_at": "2026-05-20T09:14:52Z",
        "updated_at": "2026-05-25T16:42:01Z",
        "id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
        "status": "draft"
      },
      "use_cases_attachment": {
        "created_at": "2026-05-20T09:14:52Z",
        "updated_at": "2026-05-25T16:42:01Z",
        "id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
        "status": "draft"
      },
      "video_attachment": {
        "created_at": "2026-05-20T09:14:52Z",
        "updated_at": "2026-05-25T16:42:01Z",
        "id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
        "status": "draft"
      },
      "status": "submitted",
      "next": [
        {
          "kind": "operation"
        }
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns review attempts with frozen evidence for this business, newest first, with fresh private evidence URLs.

Parametri

business_account_idstring

Parametri di query

sortstring

Field to sort by. Possible values: created_at. Defaults to created_at.

Possible values: created_at

orderstring

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

Possible values: asc, desc

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

include_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

Payload di risposta

data
array of object
obbligatorio
Mostra attributi secondari
data.id
string
obbligatorio
data.business_account_id
string
obbligatorio
data.apple_business_id
string
obbligatorio

The Apple business UUID frozen when this attempt was submitted.

data.name
string
obbligatorio

The customer-supplied Bird account name frozen when this attempt was submitted.

data.readiness_attachment
object
obbligatorio
Mostra attributi secondari
data.use_cases_attachment
object
obbligatorio
Mostra attributi secondari
data.video_attachment
object
obbligatorio
Mostra attributi secondari
data.video_attachment.created_at
string
obbligatorio
data.video_attachment.updated_at
string
obbligatorio
data.video_attachment.id
string
obbligatorio
data.video_attachment.filename
string
obbligatorio

The uploaded file's name.

data.video_attachment.content_type
string
obbligatorio

The file's content type, determined from its contents.

data.video_attachment.size_bytes
integer
obbligatorio

The file's size in bytes.

data.video_attachment.description
string

A short note describing what the file shows.

data.video_attachment.status
string
obbligatorio

Lifecycle of an attachment. draft is a file that has been uploaded but nothing has been registered or submitted with it yet, and it is discarded at its expires_at. attached means at least one registration has cited it, so it is kept permanently and can no longer be deleted.

Possible values: draft, attached

data.video_attachment.download_url
string
obbligatorio

Short-lived signed URL for downloading or previewing the attachment. Valid for 24 hours from when the resource was fetched; request a fresh resource to obtain a new URL after expiry. Do not cache beyond download_url_expires_at. Registration authorities (10DLC and toll-free carriers) retrieve evidence via a separate, longer-lived token; this URL is not that token.

data.video_attachment.preview_url
string

Optional signed URL for inline viewing on an isolated storage origin. Valid for one hour; fetch the attachment again to refresh it.

data.video_attachment.download_url_expires_at
string
obbligatorio

When download_url expires. Both fields are always present; the server returns an error rather than omitting them.

data.video_attachment.expires_at
nullable string
obbligatorio

When this attachment is discarded if nothing is registered or submitted with it. Null once its status is attached.

data.status
string
obbligatorio

The review outcome of this attempt. Earlier attempts retain their outcome when a new attempt is submitted.

data.status_reason
nullable string
obbligatorio

Review feedback on this attempt, such as the reason Apple rejected it. May contain basic Markdown, such as emphasis and lists.

data.created_at
string
obbligatorio
data.next
array of object

Read the parent business account for current eligibility and next actions. Present on create responses and each customer submission-list item; historical attempts do not establish current account state.

Mostra attributi secondari
data.updated_at
string
obbligatorio
next_cursor
nullable string
obbligatorio

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
obbligatorio

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
obbligatorio

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total
nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Continua con la documentazione, le guide e gli esempi per questo argomento.