Skip to main content
GET
This organisation's SMS provider, its sender id, and how much of its monthly ceiling is spent (ADR-075).

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

organization_id
string
mode
string
status
string
endpoint
string
encoding
string
auth
string
auth_header
string
to_field
string
text_field
string
from_field
string
extra
string
id_path
string
sender_id
string
monthly_cap
string
sent_this_month
string
verified_at
string
last_error
string
last_error_at
string
last_success_at
string
username
string
credential_hint
string
has_credential
string
credential_set_at
string
credential_set_by_name
string
credential_last_used_at
string
last_test_status
string
last_test_recipient
string
last_test_detail
string
last_test_transport
string
last_test_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

auth
string<text>
auth_header
string<text>
credential_hint
string<character varying>
Maximum string length: 12
credential_last_used_at
string<timestamp with time zone>
credential_set_at
string<timestamp with time zone>
credential_set_by_name
string<character varying>
Maximum string length: 200
encoding
string<text>
endpoint
string<text>
extra
string<jsonb>
from_field
string<text>
has_credential
boolean<boolean>
id_path
string<text>
last_error
string<text>
last_error_at
string<timestamp with time zone>
last_success_at
string<timestamp with time zone>
last_test_at
string<timestamp with time zone>
last_test_detail
string<text>
last_test_recipient
string<text>
last_test_status
string<character varying>
Maximum string length: 20
last_test_transport
string<character varying>
Maximum string length: 20
mode
string<character varying>
monthly_cap
integer<integer>
organization_id
string<uuid>

Note: This is a Primary Key.

sender_id
string<character varying>
Maximum string length: 20
sent_this_month
integer<integer>
status
string<character varying>
text_field
string<text>
to_field
string<text>
username
string<character varying>
Maximum string length: 320
verified_at
string<timestamp with time zone>