List registrations
The endpoint receives as path param project id. Supports optional query parameters to narrow the results and cursor based pagination.
Path parameters
Customer's project id
Query parameters
Status of the registration.
User tags used for the registration. Tag have to start from
Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)
Date of registration creation, ISO 8601 format. Returns registrations created after given date.
Date of registration creation, ISO 8601 format. Returns registrations created before given date.
Date of registration update, ISO 8601 format. Returns registrations update after given date.
Date of registration update, ISO 8601 format. Returns registrations updated before given date.
Sender ID value.
Ordering of the results: field name with an optional order separated by a comma. Fields that support ordering are 'id', 'status', 'senderId', 'createDate', 'updateDate' with possible ordering 'desc' or 'asc'
Size of the page to be returned.
Page token to request subsequent pages when using pagination. This should be the value generated by a system in a previous list request.
Registration type for market used in registration is for. There are different markets available depending on this type
Response
OK
Example response
{
"registrations": [
{
"attachments": [
{
"attachmentId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
"createTime": "2021-11-03T14:30:03",
"fileName": "sender_id_registration_form.docx",
"mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"updateTime": "2021-11-03T14:30:03",
"uploadStatus": "COMPLETED",
"documentType": "Passport"
}
],
"callbackUrl": "senderid.registrations.api.sinch.com",
"createTime": "2021-11-03T14:30:03",
"etaDate": "2024-11-03",
"id": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
"logs": [
{
"createTime": "2021-11-03T14:30:03",
"message": "Please update the attachment connected to your request.",
"registrationState": "PENDING"
}
],
"notificationContacts": [
"jane.doe@example.com",
"john.doe@example.com"
],
"owner": "Jane Doe",
"policyId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
"price": {
"currency": "USD",
"frequency": 1,
"mode": "SUBSCRIBED",
"recurrentFeeAmount": "2",
"setupFeeAmount": "5"
},
"registrationType": "ALPHANUMERIC_SENDER_ID",
"requestDetails": [
{
"additionalDetails": [
{
"email": "email@mycompany.com"
},
{
"companyName": "My Company Name",
"website": "https://www.mycompany.com"
}
],
"senderIdDetails": [
{
"sender": "a sender value"
}
]
}
],
"senderIds": [
"senderId1",
"senderId2"
],
"status": "IN_QUEUE",
"tags": [
"#myTag1",
"#myTag2"
],
"updateTime": "2021-11-03T14:30:03",
"servicePlanId": "a23dccbf-919d-462f-8587-dec95a1b44de"
}
]
}