List the filed copies of a registration

GET /v1/registrations/{id}/submissions

One entry per submission, oldest first: exactly what was sent for carrier review (business details, example messages, description, opt-in story) and how the checks stood. Read-only. A copy is written when you submit and never changed; a resubmission adds a new one.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes	Example: `reg_a1B2c3D4e5F6`.

Responses

Status	Meaning	Body
200	Filed copies, oldest first	Page of `RegistrationSubmission`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
404	Not found	`Error`
429	Rate limit or quota exceeded	`Error`

200: each item in `data` (RegistrationSubmission)

The body is a page: data (the array), has_more, and next_cursor (null on the last page).

Field	Type	Description
`object`	`registration_submission`
`registration_id`	string	Example: `reg_a1B2c3D4e5F6`.
`number`	integer	1 for the first submission, 2 for the first resubmission, and so on
`submitted_at`	string (date-time)
`filed_by`	`delivered_compliance`, `registry`
`reference`	string
`sample_messages`	array of string
`samples_source`	`starter`, `customer`
`description`	string
`brand`	object	The business details as filed
`campaign`	object	Use case, description, opt-in story, example messages and keyword replies as filed
`website_check`	object	Nullable.
`website_check.checked_at`	string (date-time)
`website_check.passed`	integer
`website_check.failed`	integer
`website_check.warnings`	integer
`website_check.urls`	object
`website_check.not_passing`	array of string	Ids of findings that were warnings (a failing finding blocks submission)
`sample_check`	object
`sample_check.passed`	integer
`sample_check.failed`	integer
`sample_check.warnings`	integer
`sample_check.not_passing`	array of string

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404	Not found
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/registrations/reg_a1B2c3D4e5F6/submissions" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

The Node.js SDK does not wrap this endpoint yet; call it with fetch.

javascript

const res = await fetch('https://api.joinsimplesms.com/v1/registrations/reg_a1B2c3D4e5F6/submissions', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

python

import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/registrations/reg_a1B2c3D4e5F6/submissions",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)